git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/GCC/ARM_CM3_MPU/portmacro.h

   1 /*\r
   2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 \r
  76 #ifndef PORTMACRO_H\r
  77 #define PORTMACRO_H\r
  78 \r
  79 #ifdef __cplusplus\r
  80 extern "C" {\r
  81 #endif\r
  82 \r
  83 /*-----------------------------------------------------------\r
  84  * Port specific definitions.\r
  85  *\r
  86  * The settings in this file configure FreeRTOS correctly for the\r
  87  * given hardware and compiler.\r
  88  *\r
  89  * These settings should not be altered.\r
  90  *-----------------------------------------------------------\r
  91  */\r
  92 \r
  93 /* Type definitions. */\r
  94 #define portCHAR                char\r
  95 #define portFLOAT               float\r
  96 #define portDOUBLE              double\r
  97 #define portLONG                long\r
  98 #define portSHORT               short\r
  99 #define portSTACK_TYPE  unsigned portLONG\r
 100 #define portBASE_TYPE   long\r
 101 \r
 102 #if( configUSE_16_BIT_TICKS == 1 )\r
 103         typedef unsigned portSHORT portTickType;\r
 104         #define portMAX_DELAY ( portTickType ) 0xffff\r
 105 #else\r
 106         typedef unsigned portLONG portTickType;\r
 107         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
 108 #endif\r
 109 /*-----------------------------------------------------------*/\r
 110 \r
 111 /* MPU specific constants. */\r
 112 #define portUSING_MPU_WRAPPERS          1\r
 113 #define portPRIVILEGE_BIT                       ( 0x80000000UL )\r
 114 \r
 115 #define portMPU_REGION_READ_WRITE                               ( 0x03UL << 24UL )\r
 116 #define portMPU_REGION_PRIVILEGED_READ_ONLY             ( 0x05UL << 24UL )\r
 117 #define portMPU_REGION_READ_ONLY                                ( 0x06UL << 24UL )\r
 118 #define portMPU_REGION_PRIVILEGED_READ_WRITE    ( 0x01UL << 24UL )\r
 119 #define portMPU_REGION_CACHEABLE_BUFFERABLE             ( 0x07UL << 16UL )\r
 120 #define portMPU_REGION_EXECUTE_NEVER                    ( 0x01UL << 28UL )\r
 121 \r
 122 #define portUNPRIVILEGED_FLASH_REGION           ( 0UL )\r
 123 #define portPRIVILEGED_FLASH_REGION                     ( 1UL )\r
 124 #define portPRIVILEGED_RAM_REGION                       ( 2UL )\r
 125 #define portGENERAL_PERIPHERALS_REGION          ( 3UL )\r
 126 #define portSTACK_REGION                                        ( 4UL )\r
 127 #define portFIRST_CONFIGURABLE_REGION       ( 5UL )\r
 128 #define portLAST_CONFIGURABLE_REGION            ( 7UL )\r
 129 #define portNUM_CONFIGURABLE_REGIONS            ( ( portLAST_CONFIGURABLE_REGION - portFIRST_CONFIGURABLE_REGION ) + 1 )\r
 130 #define portTOTAL_NUM_REGIONS                           ( portNUM_CONFIGURABLE_REGIONS + 1 ) /* Plus one to make space for the stack region. */\r
 131 \r
 132 #define portSWITCH_TO_USER_MODE() __asm volatile ( " mrs r0, control \n orr r0, #1 \n msr control, r0 " :::"r0" )\r
 133 \r
 134 typedef struct MPU_REGION_REGISTERS\r
 135 {\r
 136         unsigned portLONG ulRegionBaseAddress;\r
 137         unsigned portLONG ulRegionAttribute;\r
 138 } xMPU_REGION_REGISTERS;\r
 139 \r
 140 /* Plus 1 to create space for the stack region. */\r
 141 typedef struct MPU_SETTINGS\r
 142 {\r
 143         xMPU_REGION_REGISTERS xRegion[ portTOTAL_NUM_REGIONS ];\r
 144 } xMPU_SETTINGS;\r
 145 \r
 146 /* Architecture specifics. */\r
 147 #define portSTACK_GROWTH                        ( -1 )\r
 148 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )\r
 149 #define portBYTE_ALIGNMENT                      8\r
 150 /*-----------------------------------------------------------*/\r
 151 \r
 152 /* SVC numbers for various services. */\r
 153 #define portSVC_START_SCHEDULER                         0\r
 154 #define portSVC_YIELD                                           1\r
 155 #define portSVC_RAISE_PRIVILEGE                         2\r
 156 \r
 157 /* Scheduler utilities. */\r
 158 \r
 159 #define portYIELD()                             __asm volatile ( "      SVC     %0      \n" :: "i" (portSVC_YIELD) )\r
 160 #define portYIELD_WITHIN_API()  *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET\r
 161 \r
 162 #define portNVIC_INT_CTRL                       ( ( volatile unsigned portLONG *) 0xe000ed04 )\r
 163 #define portNVIC_PENDSVSET                      0x10000000\r
 164 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET\r
 165 /*-----------------------------------------------------------*/\r
 166 \r
 167 \r
 168 /* Critical section management. */\r
 169 \r
 170 /*\r
 171  * Set basepri to portMAX_SYSCALL_INTERRUPT_PRIORITY without effecting other\r
 172  * registers.  r0 is clobbered.\r
 173  */\r
 174 #define portSET_INTERRUPT_MASK()                                                \\r
 175         __asm volatile                                                                          \\r
 176         (                                                                                                       \\r
 177                 "       mov r0, %0                                                              \n"     \\r
 178                 "       msr basepri, r0                                                 \n" \\r
 179                 ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY):"r0"        \\r
 180         )\r
 181 \r
 182 /*\r
 183  * Set basepri back to 0 without effective other registers.\r
 184  * r0 is clobbered.  FAQ:  Setting BASEPRI to 0 is not a bug.  Please see \r
 185  * http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html before disagreeing.\r
 186  */\r
 187 #define portCLEAR_INTERRUPT_MASK()                      \\r
 188         __asm volatile                                                  \\r
 189         (                                                                               \\r
 190                 "       mov r0, #0                                      \n"     \\r
 191                 "       msr basepri, r0                         \n"     \\r
 192                 :::"r0"                                                         \\r
 193         )\r
 194 \r
 195 /* FAQ:  Setting BASEPRI to 0 is not a bug.  Please see \r
 196 http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html before disagreeing. */\r
 197 #define portSET_INTERRUPT_MASK_FROM_ISR()               0;portSET_INTERRUPT_MASK()\r
 198 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    portCLEAR_INTERRUPT_MASK();(void)x\r
 199 \r
 200 \r
 201 extern void vPortEnterCritical( void );\r
 202 extern void vPortExitCritical( void );\r
 203 \r
 204 #define portDISABLE_INTERRUPTS()        portSET_INTERRUPT_MASK()\r
 205 #define portENABLE_INTERRUPTS()         portCLEAR_INTERRUPT_MASK()\r
 206 #define portENTER_CRITICAL()            vPortEnterCritical()\r
 207 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
 208 /*-----------------------------------------------------------*/\r
 209 \r
 210 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 211 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 212 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 213 \r
 214 #define portNOP()\r
 215 \r
 216 /* There are an uneven number of items on the initial stack, so \r
 217 portALIGNMENT_ASSERT_pxCurrentTCB() will trigger false positive asserts. */\r
 218 #define portALIGNMENT_ASSERT_pxCurrentTCB ( void )\r
 219 \r
 220 \r
 221 #ifdef __cplusplus\r
 222 }\r
 223 #endif\r
 224 \r
 225 #endif /* PORTMACRO_H */\r
 226 \r