git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/RVDS/ARM_CA9/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 #ifndef PORTMACRO_H\r
  76 #define PORTMACRO_H\r
  77 \r
  78 #ifdef __cplusplus\r
  79 extern "C" {\r
  80 #endif\r
  81 \r
  82 /*-----------------------------------------------------------\r
  83  * Port specific definitions.\r
  84  *\r
  85  * The settings in this file configure FreeRTOS correctly for the given hardware\r
  86  * and compiler.\r
  87  *\r
  88  * These settings should not be altered.\r
  89  *-----------------------------------------------------------\r
  90  */\r
  91 \r
  92 /* Type definitions. */\r
  93 #define portCHAR                char\r
  94 #define portFLOAT               float\r
  95 #define portDOUBLE              double\r
  96 #define portLONG                long\r
  97 #define portSHORT               short\r
  98 #define portSTACK_TYPE  unsigned long\r
  99 #define portBASE_TYPE   portLONG\r
 100 \r
 101 #if( configUSE_16_BIT_TICKS == 1 )\r
 102         typedef unsigned short portTickType;\r
 103         #define portMAX_DELAY ( portTickType ) 0xffff\r
 104 #else\r
 105         typedef unsigned long portTickType;\r
 106         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
 107 #endif\r
 108 /*-----------------------------------------------------------*/\r
 109 \r
 110 /* Hardware specifics. */\r
 111 #define portSTACK_GROWTH                        ( -1 )\r
 112 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )\r
 113 #define portBYTE_ALIGNMENT                      8\r
 114 \r
 115 /*-----------------------------------------------------------*/\r
 116 \r
 117 /* Task utilities. */\r
 118 \r
 119 /* Called at the end of an ISR that can cause a context switch. */\r
 120 #define portEND_SWITCHING_ISR( xSwitchRequired )\\r
 121 {                                                                                               \\r
 122 extern unsigned long ulPortYieldRequired;               \\r
 123                                                                                                 \\r
 124         if( xSwitchRequired != pdFALSE )                        \\r
 125         {                                                                                       \\r
 126                 ulPortYieldRequired = pdTRUE;                   \\r
 127         }                                                                                       \\r
 128 }\r
 129 \r
 130 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
 131 #define portYIELD() __asm( "SWI 0" );\r
 132 \r
 133 \r
 134 /*-----------------------------------------------------------\r
 135  * Critical section control\r
 136  *----------------------------------------------------------*/\r
 137 \r
 138 extern void vPortEnterCritical( void );\r
 139 extern void vPortExitCritical( void );\r
 140 extern unsigned long ulPortSetInterruptMask( void );\r
 141 extern void vPortClearInterruptMask( unsigned long ulNewMaskValue );\r
 142 \r
 143 /* These macros do not globally disable/enable interrupts.  They do mask off\r
 144 interrupts that have a priority below configMAX_API_CALL_INTERRUPT_PRIORITY. */\r
 145 #define portENTER_CRITICAL()            vPortEnterCritical();\r
 146 #define portEXIT_CRITICAL()                     vPortExitCritical();\r
 147 #define portDISABLE_INTERRUPTS()        ulPortSetInterruptMask()\r
 148 #define portENABLE_INTERRUPTS()         vPortClearInterruptMask( 0 )\r
 149 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortSetInterruptMask()\r
 150 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortClearInterruptMask(x)\r
 151 \r
 152 /*-----------------------------------------------------------*/\r
 153 \r
 154 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 155 not required for this port but included in case common demo code that uses these\r
 156 macros is used. */\r
 157 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )      void vFunction( void *pvParameters )\r
 158 #define portTASK_FUNCTION( vFunction, pvParameters )    void vFunction( void *pvParameters )\r
 159 \r
 160 /* Prototype of the FreeRTOS tick handler.  This must be installed as the\r
 161 handler for whichever peripheral is used to generate the RTOS tick. */\r
 162 void FreeRTOS_Tick_Handler( void );\r
 163 \r
 164 /* Any task that uses the floating point unit MUST call vPortTaskUsesFPU()\r
 165 before any floating point instructions are executed. */\r
 166 void vPortTaskUsesFPU( void );\r
 167 #define portTASK_USES_FLOATING_POINT() vPortTaskUsesFPU()\r
 168 \r
 169 #define portLOWEST_INTERRUPT_PRIORITY ( ( ( unsigned long ) configUNIQUE_INTERRUPT_PRIORITIES ) - 1UL )\r
 170 #define portLOWEST_USABLE_INTERRUPT_PRIORITY ( portLOWEST_INTERRUPT_PRIORITY - 1UL )\r
 171 \r
 172 /* Architecture specific optimisations. */\r
 173 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 174 \r
 175         /* Store/clear the ready priorities in a bit map. */\r
 176         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 177         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 178 \r
 179         /*-----------------------------------------------------------*/\r
 180 \r
 181         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - __clz( uxReadyPriorities ) )\r
 182 \r
 183 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 184 \r
 185 #define portNOP() __nop()\r
 186 \r
 187 #ifdef __cplusplus\r
 188 }\r
 189 #endif\r
 190 \r
 191 #endif /* PORTMACRO_H */\r
 192 \r