git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/CodeWarrior/HCS12/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 /*-----------------------------------------------------------\r
  80  * Port specific definitions.  \r
  81  *\r
  82  * The settings in this file configure FreeRTOS correctly for the\r
  83  * given hardware and compiler.\r
  84  *\r
  85  * These settings should not be altered.\r
  86  *-----------------------------------------------------------\r
  87  */\r
  88 \r
  89 /* Type definitions. */\r
  90 #define portCHAR                char\r
  91 #define portFLOAT               float\r
  92 #define portDOUBLE              double\r
  93 #define portLONG                long\r
  94 #define portSHORT               short\r
  95 #define portSTACK_TYPE  unsigned portCHAR\r
  96 #define portBASE_TYPE   char\r
  97 \r
  98 #if( configUSE_16_BIT_TICKS == 1 )\r
  99         typedef unsigned portSHORT portTickType;\r
 100         #define portMAX_DELAY ( portTickType ) 0xffff\r
 101 #else\r
 102         typedef unsigned portLONG portTickType;\r
 103         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
 104 #endif\r
 105 /*-----------------------------------------------------------*/\r
 106 \r
 107 /* Hardware specifics. */\r
 108 #define portBYTE_ALIGNMENT                      1\r
 109 #define portSTACK_GROWTH                        ( -1 )\r
 110 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
 111 #define portYIELD()                                     __asm( "swi" );\r
 112 #define portNOP()                                       __asm( "nop" );\r
 113 /*-----------------------------------------------------------*/\r
 114 \r
 115 /* Critical section handling. */\r
 116 #define portENABLE_INTERRUPTS()                         __asm( "cli" )  \r
 117 #define portDISABLE_INTERRUPTS()                        __asm( "sei" )\r
 118 \r
 119 /*\r
 120  * Disable interrupts before incrementing the count of critical section nesting.\r
 121  * The nesting count is maintained so we know when interrupts should be\r
 122  * re-enabled.  Once interrupts are disabled the nesting count can be accessed\r
 123  * directly.  Each task maintains its own nesting count.\r
 124  */\r
 125 #define portENTER_CRITICAL()                                                                    \\r
 126 {                                                                                                                               \\r
 127         extern volatile unsigned portBASE_TYPE uxCriticalNesting;       \\r
 128                                                                                                                                 \\r
 129         portDISABLE_INTERRUPTS();                                                                       \\r
 130         uxCriticalNesting++;                                                                            \\r
 131 }\r
 132 \r
 133 /*\r
 134  * Interrupts are disabled so we can access the nesting count directly.  If the\r
 135  * nesting is found to be 0 (no nesting) then we are leaving the critical \r
 136  * section and interrupts can be re-enabled.\r
 137  */\r
 138 #define  portEXIT_CRITICAL()                                                                    \\r
 139 {                                                                                                                               \\r
 140         extern volatile unsigned portBASE_TYPE uxCriticalNesting;       \\r
 141                                                                                                                                 \\r
 142         uxCriticalNesting--;                                                                            \\r
 143         if( uxCriticalNesting == 0 )                                                            \\r
 144         {                                                                                                                       \\r
 145                 portENABLE_INTERRUPTS();                                                                \\r
 146         }                                                                                                                       \\r
 147 }\r
 148 /*-----------------------------------------------------------*/\r
 149 \r
 150 /* Task utilities. */\r
 151 \r
 152 /* \r
 153  * These macros are very simple as the processor automatically saves and \r
 154  * restores its registers as interrupts are entered and exited.  In\r
 155  * addition to the (automatically stacked) registers we also stack the \r
 156  * critical nesting count.  Each task maintains its own critical nesting\r
 157  * count as it is legitimate for a task to yield from within a critical\r
 158  * section.  If the banked memory model is being used then the PPAGE\r
 159  * register is also stored as part of the tasks context.\r
 160  */\r
 161 \r
 162 #ifdef BANKED_MODEL\r
 163         /* \r
 164          * Load the stack pointer for the task, then pull the critical nesting\r
 165          * count and PPAGE register from the stack.  The remains of the \r
 166          * context are restored by the RTI instruction.\r
 167          */\r
 168         #define portRESTORE_CONTEXT()                                                                   \\r
 169         {                                                                                                                               \\r
 170                 extern volatile void * pxCurrentTCB;                                            \\r
 171                 extern volatile unsigned portBASE_TYPE uxCriticalNesting;       \\r
 172                                                                                                                                         \\r
 173                 __asm( "ldx pxCurrentTCB" );                                                            \\r
 174                 __asm( "lds 0, x" );                                                                            \\r
 175                 __asm( "pula" );                                                                                        \\r
 176                 __asm( "staa uxCriticalNesting" );                                                      \\r
 177                 __asm( "pula" );                                                                                        \\r
 178                 __asm( "staa 0x30" ); /* 0x30 = PPAGE */                                        \\r
 179         }\r
 180 \r
 181         /* \r
 182          * By the time this macro is called the processor has already stacked the\r
 183          * registers.  Simply stack the nesting count and PPAGE value, then save \r
 184          * the task stack pointer.\r
 185          */\r
 186         #define portSAVE_CONTEXT()                                                                              \\r
 187         {                                                                                                                               \\r
 188                 extern volatile void * pxCurrentTCB;                                            \\r
 189                 extern volatile unsigned portBASE_TYPE uxCriticalNesting;       \\r
 190                                                                                                                                         \\r
 191                 __asm( "ldaa 0x30" );  /* 0x30 = PPAGE */                                       \\r
 192                 __asm( "psha" );                                                                                        \\r
 193                 __asm( "ldaa uxCriticalNesting" );                                                      \\r
 194                 __asm( "psha" );                                                                                        \\r
 195                 __asm( "ldx pxCurrentTCB" );                                                            \\r
 196                 __asm( "sts 0, x" );                                                                            \\r
 197         }\r
 198 #else\r
 199 \r
 200         /* \r
 201          * These macros are as per the BANKED versions above, but without saving\r
 202          * and restoring the PPAGE register.\r
 203          */\r
 204 \r
 205         #define portRESTORE_CONTEXT()                                                                   \\r
 206         {                                                                                                                               \\r
 207                 extern volatile void * pxCurrentTCB;                                            \\r
 208                 extern volatile unsigned portBASE_TYPE uxCriticalNesting;       \\r
 209                                                                                                                                         \\r
 210                 __asm( "ldx pxCurrentTCB" );                                                            \\r
 211                 __asm( "lds 0, x" );                                                                            \\r
 212                 __asm( "pula" );                                                                                        \\r
 213                 __asm( "staa uxCriticalNesting" );                                                      \\r
 214         }\r
 215 \r
 216         #define portSAVE_CONTEXT()                                                                              \\r
 217         {                                                                                                                               \\r
 218                 extern volatile void * pxCurrentTCB;                                            \\r
 219                 extern volatile unsigned portBASE_TYPE uxCriticalNesting;       \\r
 220                                                                                                                                         \\r
 221                 __asm( "ldaa uxCriticalNesting" );                                                      \\r
 222                 __asm( "psha" );                                                                                        \\r
 223                 __asm( "ldx pxCurrentTCB" );                                                            \\r
 224                 __asm( "sts 0, x" );                                                                            \\r
 225         }\r
 226 #endif\r
 227 \r
 228 /*\r
 229  * Utility macro to call macros above in correct order in order to perform a\r
 230  * task switch from within a standard ISR.  This macro can only be used if\r
 231  * the ISR does not use any local (stack) variables.  If the ISR uses stack\r
 232  * variables portYIELD() should be used in it's place.\r
 233  */\r
 234 #define portTASK_SWITCH_FROM_ISR()                                                              \\r
 235         portSAVE_CONTEXT();                                                                                     \\r
 236         vTaskSwitchContext();                                                                           \\r
 237         portRESTORE_CONTEXT();\r
 238 \r
 239 \r
 240 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 241 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 242 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 243 \r
 244 #endif /* PORTMACRO_H */\r
 245 \r