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

   1 /*\r
   2     FreeRTOS V8.2.0rc1 - Copyright (C) 2014 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     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  14     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  15     >>!   obliged to provide the source code for proprietary components     !<<\r
  16     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  17 \r
  18     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  19     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  20     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  21     link: http://www.freertos.org/a00114.html\r
  22 \r
  23     1 tab == 4 spaces!\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  28      *    not run, what could be wrong?".  Have you defined configASSERT()?  *\r
  29      *                                                                       *\r
  30      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  31      *                                                                       *\r
  32     ***************************************************************************\r
  33 \r
  34     ***************************************************************************\r
  35      *                                                                       *\r
  36      *    FreeRTOS provides completely free yet professionally developed,    *\r
  37      *    robust, strictly quality controlled, supported, and cross          *\r
  38      *    platform software that is more than just the market leader, it     *\r
  39      *    is the industry's de facto standard.                               *\r
  40      *                                                                       *\r
  41      *    Help yourself get started quickly while simultaneously helping     *\r
  42      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  43      *    tutorial book, reference manual, or both:                          *\r
  44      *    http://www.FreeRTOS.org/Documentation                              *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     ***************************************************************************\r
  49      *                                                                       *\r
  50      *   Investing in training allows your team to be as productive as       *\r
  51      *   possible as early as possible, lowering your overall development    *\r
  52      *   cost, and enabling you to bring a more robust product to market     *\r
  53      *   earlier than would otherwise be possible.  Richard Barry is both    *\r
  54      *   the architect and key author of FreeRTOS, and so also the world's   *\r
  55      *   leading authority on what is the world's most popular real time     *\r
  56      *   kernel for deeply embedded MCU designs.  Obtaining your training    *\r
  57      *   from Richard ensures your team will gain directly from his in-depth *\r
  58      *   product knowledge and years of usage experience.  Contact Real Time *\r
  59      *   Engineers Ltd to enquire about the FreeRTOS Masterclass, presented  *\r
  60      *   by Richard Barry:  http://www.FreeRTOS.org/contact\r
  61      *                                                                       *\r
  62     ***************************************************************************\r
  63 \r
  64     ***************************************************************************\r
  65      *                                                                       *\r
  66      *    You are receiving this top quality software for free.  Please play *\r
  67      *    fair and reciprocate by reporting any suspected issues and         *\r
  68      *    participating in the community forum:                              *\r
  69      *    http://www.FreeRTOS.org/support                                    *\r
  70      *                                                                       *\r
  71      *    Thank you!                                                         *\r
  72      *                                                                       *\r
  73     ***************************************************************************\r
  74 \r
  75     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  76     license and Real Time Engineers Ltd. contact details.\r
  77 \r
  78     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  79     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  80     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  81 \r
  82     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  83     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  84 \r
  85     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  86     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  87     licenses offer ticketed support, indemnification and commercial middleware.\r
  88 \r
  89     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  90     engineered and independently SIL3 certified version for use in safety and\r
  91     mission critical applications that require provable dependability.\r
  92 \r
  93     1 tab == 4 spaces!\r
  94 */\r
  95 \r
  96 #ifndef PORTMACRO_H\r
  97 #define PORTMACRO_H\r
  98 \r
  99 #ifdef __cplusplus\r
 100         extern "C" {\r
 101 #endif\r
 102 \r
 103 /*-----------------------------------------------------------\r
 104  * Port specific definitions.\r
 105  *\r
 106  * The settings in this file configure FreeRTOS correctly for the given hardware\r
 107  * and compiler.\r
 108  *\r
 109  * These settings should not be altered.\r
 110  *-----------------------------------------------------------\r
 111  */\r
 112 \r
 113 /* Type definitions. */\r
 114 #define portCHAR                char\r
 115 #define portFLOAT               float\r
 116 #define portDOUBLE              double\r
 117 #define portLONG                long\r
 118 #define portSHORT               short\r
 119 #define portSTACK_TYPE  uint32_t\r
 120 #define portBASE_TYPE   long\r
 121 \r
 122 typedef portSTACK_TYPE StackType_t;\r
 123 typedef long BaseType_t;\r
 124 typedef unsigned long UBaseType_t;\r
 125 \r
 126 typedef uint32_t TickType_t;\r
 127 #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
 128 \r
 129 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
 130 not need to be guarded with a critical section. */\r
 131 #define portTICK_TYPE_IS_ATOMIC 1\r
 132 \r
 133 /*-----------------------------------------------------------*/\r
 134 \r
 135 /* Hardware specifics. */\r
 136 #define portSTACK_GROWTH                        ( -1 )\r
 137 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 138 #define portBYTE_ALIGNMENT                      8\r
 139 \r
 140 /*-----------------------------------------------------------*/\r
 141 \r
 142 /* Task utilities. */\r
 143 \r
 144 /* Called at the end of an ISR that can cause a context switch. */\r
 145 #define portEND_SWITCHING_ISR( xSwitchRequired )\\r
 146 {                                                                                               \\r
 147 extern uint32_t ulPortYieldRequired;                    \\r
 148                                                                                                 \\r
 149         if( xSwitchRequired != pdFALSE )                        \\r
 150         {                                                                                       \\r
 151                 ulPortYieldRequired = pdTRUE;                   \\r
 152         }                                                                                       \\r
 153 }\r
 154 \r
 155 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
 156 #define portYIELD() __asm volatile ( "SWI 0" );\r
 157 \r
 158 \r
 159 /*-----------------------------------------------------------\r
 160  * Critical section control\r
 161  *----------------------------------------------------------*/\r
 162 \r
 163 extern void vPortEnterCritical( void );\r
 164 extern void vPortExitCritical( void );\r
 165 extern uint32_t ulPortSetInterruptMask( void );\r
 166 extern void vPortClearInterruptMask( uint32_t ulNewMaskValue );\r
 167 extern void vPortInstallFreeRTOSVectorTable( void );\r
 168 \r
 169 /* These macros do not globally disable/enable interrupts.  They do mask off\r
 170 interrupts that have a priority below configMAX_API_CALL_INTERRUPT_PRIORITY. */\r
 171 #define portENTER_CRITICAL()            vPortEnterCritical();\r
 172 #define portEXIT_CRITICAL()                     vPortExitCritical();\r
 173 #define portDISABLE_INTERRUPTS()        ulPortSetInterruptMask()\r
 174 #define portENABLE_INTERRUPTS()         vPortClearInterruptMask( 0 )\r
 175 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortSetInterruptMask()\r
 176 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortClearInterruptMask(x)\r
 177 \r
 178 /*-----------------------------------------------------------*/\r
 179 \r
 180 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 181 not required for this port but included in case common demo code that uses these\r
 182 macros is used. */\r
 183 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )      void vFunction( void *pvParameters )\r
 184 #define portTASK_FUNCTION( vFunction, pvParameters )    void vFunction( void *pvParameters )\r
 185 \r
 186 /* Prototype of the FreeRTOS tick handler.  This must be installed as the\r
 187 handler for whichever peripheral is used to generate the RTOS tick. */\r
 188 void FreeRTOS_Tick_Handler( void );\r
 189 \r
 190 /* Any task that uses the floating point unit MUST call vPortTaskUsesFPU()\r
 191 before any floating point instructions are executed. */\r
 192 void vPortTaskUsesFPU( void );\r
 193 #define portTASK_USES_FLOATING_POINT() vPortTaskUsesFPU()\r
 194 \r
 195 #define portLOWEST_INTERRUPT_PRIORITY ( ( ( uint32_t ) configUNIQUE_INTERRUPT_PRIORITIES ) - 1UL )\r
 196 #define portLOWEST_USABLE_INTERRUPT_PRIORITY ( portLOWEST_INTERRUPT_PRIORITY - 1UL )\r
 197 \r
 198 /* Architecture specific optimisations. */\r
 199 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 200         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 201 #endif\r
 202 \r
 203 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 204 \r
 205         /* Store/clear the ready priorities in a bit map. */\r
 206         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 207         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 208 \r
 209         /*-----------------------------------------------------------*/\r
 210 \r
 211         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - __builtin_clz( uxReadyPriorities ) )\r
 212 \r
 213 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 214 \r
 215 #ifdef configASSERT\r
 216         void vPortValidateInterruptPriority( void );\r
 217         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()      vPortValidateInterruptPriority()\r
 218 #endif /* configASSERT */\r
 219 \r
 220 #define portNOP() __asm volatile( "NOP" )\r
 221 \r
 222 \r
 223 #ifdef __cplusplus\r
 224         } /* extern C */\r
 225 #endif\r
 226 \r
 227 \r
 228 /* The number of bits to shift for an interrupt priority is dependent on the\r
 229 number of bits implemented by the interrupt controller. */\r
 230 #if configUNIQUE_INTERRUPT_PRIORITIES == 16\r
 231         #define portPRIORITY_SHIFT 4\r
 232         #define portMAX_BINARY_POINT_VALUE      3\r
 233 #elif configUNIQUE_INTERRUPT_PRIORITIES == 32\r
 234         #define portPRIORITY_SHIFT 3\r
 235         #define portMAX_BINARY_POINT_VALUE      2\r
 236 #elif configUNIQUE_INTERRUPT_PRIORITIES == 64\r
 237         #define portPRIORITY_SHIFT 2\r
 238         #define portMAX_BINARY_POINT_VALUE      1\r
 239 #elif configUNIQUE_INTERRUPT_PRIORITIES == 128\r
 240         #define portPRIORITY_SHIFT 1\r
 241         #define portMAX_BINARY_POINT_VALUE      0\r
 242 #elif configUNIQUE_INTERRUPT_PRIORITIES == 256\r
 243         #define portPRIORITY_SHIFT 0\r
 244         #define portMAX_BINARY_POINT_VALUE      0\r
 245 #else\r
 246         #error Invalid configUNIQUE_INTERRUPT_PRIORITIES setting.  configUNIQUE_INTERRUPT_PRIORITIES must be set to the number of unique priorities implemented by the target hardware\r
 247 #endif\r
 248 \r
 249 /* Interrupt controller access addresses. */\r
 250 #define portICCPMR_PRIORITY_MASK_OFFSET                                                 ( 0x04 )\r
 251 #define portICCIAR_INTERRUPT_ACKNOWLEDGE_OFFSET                                 ( 0x0C )\r
 252 #define portICCEOIR_END_OF_INTERRUPT_OFFSET                                     ( 0x10 )\r
 253 #define portICCBPR_BINARY_POINT_OFFSET                                                  ( 0x08 )\r
 254 #define portICCRPR_RUNNING_PRIORITY_OFFSET                                              ( 0x14 )\r
 255 \r
 256 #define portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS          ( configINTERRUPT_CONTROLLER_BASE_ADDRESS + configINTERRUPT_CONTROLLER_CPU_INTERFACE_OFFSET )\r
 257 #define portICCPMR_PRIORITY_MASK_REGISTER                                       ( *( ( volatile uint32_t * ) ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCPMR_PRIORITY_MASK_OFFSET ) ) )\r
 258 #define portICCIAR_INTERRUPT_ACKNOWLEDGE_REGISTER_ADDRESS       ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCIAR_INTERRUPT_ACKNOWLEDGE_OFFSET )\r
 259 #define portICCEOIR_END_OF_INTERRUPT_REGISTER_ADDRESS           ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCEOIR_END_OF_INTERRUPT_OFFSET )\r
 260 #define portICCPMR_PRIORITY_MASK_REGISTER_ADDRESS                       ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCPMR_PRIORITY_MASK_OFFSET )\r
 261 #define portICCBPR_BINARY_POINT_REGISTER                                        ( *( ( const volatile uint32_t * ) ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCBPR_BINARY_POINT_OFFSET ) ) )\r
 262 #define portICCRPR_RUNNING_PRIORITY_REGISTER                            ( *( ( const volatile uint32_t * ) ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCRPR_RUNNING_PRIORITY_OFFSET ) ) )\r
 263 \r
 264 #endif /* PORTMACRO_H */\r
 265 \r