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

   1 /*\r
   2         FreeRTOS V5.4.2 - Copyright (C) 2009 Real Time Engineers Ltd.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS is free software; you can redistribute it and/or modify it     under\r
   7         the terms of the GNU General Public License (version 2) as published by the\r
   8         Free Software Foundation and modified by the FreeRTOS exception.\r
   9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
  10         combined work that includes FreeRTOS without being obliged to provide the\r
  11         source code for proprietary components outside of the FreeRTOS kernel.\r
  12         Alternative commercial license and support terms are also available upon\r
  13         request.  See the licensing section of http://www.FreeRTOS.org for full\r
  14         license details.\r
  15 \r
  16         FreeRTOS is distributed in the hope that it will be useful,     but WITHOUT\r
  17         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  18         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  19         more details.\r
  20 \r
  21         You should have received a copy of the GNU General Public License along\r
  22         with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
  23         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  24 \r
  25 \r
  26         ***************************************************************************\r
  27         *                                                                                                                                                *\r
  28         * Looking for a quick start?  Then check out the FreeRTOS eBook!                  *\r
  29         * See http://www.FreeRTOS.org/Documentation for details                            *\r
  30         *                                                                                                                                                *\r
  31         ***************************************************************************\r
  32 \r
  33         1 tab == 4 spaces!\r
  34 \r
  35         Please ensure to read the configuration and relevant port sections of the\r
  36         online documentation.\r
  37 \r
  38         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  39         contact details.\r
  40 \r
  41         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  42         critical systems.\r
  43 \r
  44         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  45         licensing and training services.\r
  46 */\r
  47 \r
  48 \r
  49 #ifndef PORTMACRO_H\r
  50 #define PORTMACRO_H\r
  51 \r
  52 #ifdef __cplusplus\r
  53 extern "C" {\r
  54 #endif\r
  55 \r
  56 /*-----------------------------------------------------------\r
  57  * Port specific definitions.\r
  58  *\r
  59  * The settings in this file configure FreeRTOS correctly for the\r
  60  * given hardware and compiler.\r
  61  *\r
  62  * These settings should not be altered.\r
  63  *-----------------------------------------------------------\r
  64  */\r
  65 \r
  66 /* Type definitions. */\r
  67 #define portCHAR                char\r
  68 #define portFLOAT               float\r
  69 #define portDOUBLE              double\r
  70 #define portLONG                long\r
  71 #define portSHORT               short\r
  72 #define portSTACK_TYPE  unsigned portLONG\r
  73 #define portBASE_TYPE   long\r
  74 \r
  75 #if( configUSE_16_BIT_TICKS == 1 )\r
  76         typedef unsigned portSHORT portTickType;\r
  77         #define portMAX_DELAY ( portTickType ) 0xffff\r
  78 #else\r
  79         typedef unsigned portLONG portTickType;\r
  80         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
  81 #endif\r
  82 /*-----------------------------------------------------------*/\r
  83 \r
  84 /* MPU specific constants. */\r
  85 #define portUSING_MPU_WRAPPERS          1\r
  86 #define portPRIVILEGE_BIT                       ( 0x80000000UL )\r
  87 \r
  88 #define portMPU_REGION_READ_WRITE                               ( 0x03UL << 24UL )\r
  89 #define portMPU_REGION_PRIVILEGED_READ_ONLY             ( 0x05UL << 24UL )\r
  90 #define portMPU_REGION_READ_ONLY                                ( 0x06UL << 24UL )\r
  91 #define portMPU_REGION_PRIVILEGED_READ_WRITE    ( 0x01UL << 24UL )\r
  92 #define portMPU_REGION_CACHEABLE_BUFFERABLE             ( 0x07UL << 16UL )\r
  93 #define portMPU_REGION_EXECUTE_NEVER                    ( 0x01UL << 28UL )\r
  94 \r
  95 #define portUNPRIVILEGED_FLASH_REGION           ( 0UL )\r
  96 #define portPRIVILEGED_FLASH_REGION                     ( 1UL )\r
  97 #define portPRIVILEGED_RAM_REGION                       ( 2UL )\r
  98 #define portGENERAL_PERIPHERALS_REGION          ( 3UL )\r
  99 #define portSTACK_REGION                                        ( 4UL )\r
 100 #define portFIRST_CONFIGURABLE_REGION       ( 5UL )\r
 101 #define portLAST_CONFIGURABLE_REGION            ( 7UL )\r
 102 #define portNUM_CONFIGURABLE_REGIONS            ( ( portLAST_CONFIGURABLE_REGION - portFIRST_CONFIGURABLE_REGION ) + 1 )\r
 103 #define portTOTAL_NUM_REGIONS                           ( portNUM_CONFIGURABLE_REGIONS + 1 ) /* Plus one to make space for the stack region. */\r
 104 \r
 105 #define portSWITCH_TO_USER_MODE() __asm volatile ( " mrs r0, control \n orr r0, #1 \n msr control, r0 " )\r
 106 \r
 107 typedef struct MPU_REGION_REGISTERS\r
 108 {\r
 109         unsigned portLONG ulRegionBaseAddress;\r
 110         unsigned portLONG ulRegionAttribute;\r
 111 } xMPU_REGION_REGISTERS;\r
 112 \r
 113 /* Plus 1 to create space for the stack region. */\r
 114 typedef struct MPU_SETTINGS\r
 115 {\r
 116         xMPU_REGION_REGISTERS xRegion[ portTOTAL_NUM_REGIONS ];\r
 117 } xMPU_SETTINGS;\r
 118 \r
 119 /* Architecture specifics. */\r
 120 #define portSTACK_GROWTH                        ( -1 )\r
 121 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )\r
 122 #define portBYTE_ALIGNMENT                      8\r
 123 /*-----------------------------------------------------------*/\r
 124 \r
 125 /* SVC numbers for various services. */\r
 126 #define portSVC_START_SCHEDULER                         0\r
 127 #define portSVC_YIELD                                           1\r
 128 #define portSVC_prvRaisePrivilege                       2\r
 129 \r
 130 /* Scheduler utilities. */\r
 131 \r
 132 #define portYIELD()                             __asm volatile ( "      SVC     %0      \n" :: "i" (portSVC_YIELD) )\r
 133 #define portYIELD_WITHIN_API()  *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET\r
 134 \r
 135 #define portNVIC_INT_CTRL                       ( ( volatile unsigned portLONG *) 0xe000ed04 )\r
 136 #define portNVIC_PENDSVSET                      0x10000000\r
 137 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET\r
 138 /*-----------------------------------------------------------*/\r
 139 \r
 140 \r
 141 /* Critical section management. */\r
 142 \r
 143 /*\r
 144  * Set basepri to portMAX_SYSCALL_INTERRUPT_PRIORITY without effecting other\r
 145  * registers.  r0 is clobbered.\r
 146  */\r
 147 #define portSET_INTERRUPT_MASK()                                                \\r
 148         __asm volatile                                                                          \\r
 149         (                                                                                                       \\r
 150                 "       mov r0, %0                                                              \n"     \\r
 151                 "       msr basepri, r0                                                 \n" \\r
 152                 ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY):"r0"        \\r
 153         )\r
 154 \r
 155 /*\r
 156  * Set basepri back to 0 without effective other registers.\r
 157  * r0 is clobbered.\r
 158  */\r
 159 #define portCLEAR_INTERRUPT_MASK()                      \\r
 160         __asm volatile                                                  \\r
 161         (                                                                               \\r
 162                 "       mov r0, #0                                      \n"     \\r
 163                 "       msr basepri, r0                         \n"     \\r
 164                 :::"r0"                                                         \\r
 165         )\r
 166 \r
 167 #define portSET_INTERRUPT_MASK_FROM_ISR()               0;portSET_INTERRUPT_MASK()\r
 168 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    portCLEAR_INTERRUPT_MASK();(void)x\r
 169 \r
 170 \r
 171 extern void vPortEnterCritical( void );\r
 172 extern void vPortExitCritical( void );\r
 173 \r
 174 #define portDISABLE_INTERRUPTS()        portSET_INTERRUPT_MASK()\r
 175 #define portENABLE_INTERRUPTS()         portCLEAR_INTERRUPT_MASK()\r
 176 #define portENTER_CRITICAL()            vPortEnterCritical()\r
 177 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
 178 /*-----------------------------------------------------------*/\r
 179 \r
 180 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 181 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 182 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 183 \r
 184 #define portNOP()\r
 185 \r
 186 \r
 187 \r
 188 #ifdef __cplusplus\r
 189 }\r
 190 #endif\r
 191 \r
 192 #endif /* PORTMACRO_H */\r
 193 \r