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

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