git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/CodeWarrior/HCS12/portmacro.h

   1 /*\r
   2     FreeRTOS V8.2.2 - Copyright (C) 2015 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     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 \r
  71 #ifndef PORTMACRO_H\r
  72 #define PORTMACRO_H\r
  73 \r
  74 /*-----------------------------------------------------------\r
  75  * Port specific definitions.\r
  76  *\r
  77  * The settings in this file configure FreeRTOS correctly for the\r
  78  * given hardware and compiler.\r
  79  *\r
  80  * These settings should not be altered.\r
  81  *-----------------------------------------------------------\r
  82  */\r
  83 \r
  84 /* Type definitions. */\r
  85 #define portCHAR                char\r
  86 #define portFLOAT               float\r
  87 #define portDOUBLE              double\r
  88 #define portLONG                long\r
  89 #define portSHORT               short\r
  90 #define portSTACK_TYPE  uint8_t\r
  91 #define portBASE_TYPE   char\r
  92 \r
  93 typedef portSTACK_TYPE StackType_t;\r
  94 typedef signed char BaseType_t;\r
  95 typedef unsigned char UBaseType_t;\r
  96 \r
  97 #if( configUSE_16_BIT_TICKS == 1 )\r
  98         typedef uint16_t TickType_t;\r
  99         #define portMAX_DELAY ( TickType_t ) 0xffff\r
 100 #else\r
 101         typedef uint32_t TickType_t;\r
 102         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
 103 #endif\r
 104 /*-----------------------------------------------------------*/\r
 105 \r
 106 /* Hardware specifics. */\r
 107 #define portBYTE_ALIGNMENT                      1\r
 108 #define portSTACK_GROWTH                        ( -1 )\r
 109 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 110 #define portYIELD()                                     __asm( "swi" );\r
 111 #define portNOP()                                       __asm( "nop" );\r
 112 /*-----------------------------------------------------------*/\r
 113 \r
 114 /* Critical section handling. */\r
 115 #define portENABLE_INTERRUPTS()                         __asm( "cli" )\r
 116 #define portDISABLE_INTERRUPTS()                        __asm( "sei" )\r
 117 \r
 118 /*\r
 119  * Disable interrupts before incrementing the count of critical section nesting.\r
 120  * The nesting count is maintained so we know when interrupts should be\r
 121  * re-enabled.  Once interrupts are disabled the nesting count can be accessed\r
 122  * directly.  Each task maintains its own nesting count.\r
 123  */\r
 124 #define portENTER_CRITICAL()                                                                    \\r
 125 {                                                                                                                               \\r
 126         extern volatile UBaseType_t uxCriticalNesting;  \\r
 127                                                                                                                                 \\r
 128         portDISABLE_INTERRUPTS();                                                                       \\r
 129         uxCriticalNesting++;                                                                            \\r
 130 }\r
 131 \r
 132 /*\r
 133  * Interrupts are disabled so we can access the nesting count directly.  If the\r
 134  * nesting is found to be 0 (no nesting) then we are leaving the critical\r
 135  * section and interrupts can be re-enabled.\r
 136  */\r
 137 #define  portEXIT_CRITICAL()                                                                    \\r
 138 {                                                                                                                               \\r
 139         extern volatile UBaseType_t uxCriticalNesting;  \\r
 140                                                                                                                                 \\r
 141         uxCriticalNesting--;                                                                            \\r
 142         if( uxCriticalNesting == 0 )                                                            \\r
 143         {                                                                                                                       \\r
 144                 portENABLE_INTERRUPTS();                                                                \\r
 145         }                                                                                                                       \\r
 146 }\r
 147 /*-----------------------------------------------------------*/\r
 148 \r
 149 /* Task utilities. */\r
 150 \r
 151 /*\r
 152  * These macros are very simple as the processor automatically saves and\r
 153  * restores its registers as interrupts are entered and exited.  In\r
 154  * addition to the (automatically stacked) registers we also stack the\r
 155  * critical nesting count.  Each task maintains its own critical nesting\r
 156  * count as it is legitimate for a task to yield from within a critical\r
 157  * section.  If the banked memory model is being used then the PPAGE\r
 158  * register is also stored as part of the tasks context.\r
 159  */\r
 160 \r
 161 #ifdef BANKED_MODEL\r
 162         /*\r
 163          * Load the stack pointer for the task, then pull the critical nesting\r
 164          * count and PPAGE register from the stack.  The remains of the\r
 165          * context are restored by the RTI instruction.\r
 166          */\r
 167         #define portRESTORE_CONTEXT()                                                                   \\r
 168         {                                                                                                                               \\r
 169                 extern volatile void * pxCurrentTCB;                                            \\r
 170                 extern volatile UBaseType_t uxCriticalNesting;  \\r
 171                                                                                                                                         \\r
 172                 __asm( "ldx pxCurrentTCB" );                                                            \\r
 173                 __asm( "lds 0, x" );                                                                            \\r
 174                 __asm( "pula" );                                                                                        \\r
 175                 __asm( "staa uxCriticalNesting" );                                                      \\r
 176                 __asm( "pula" );                                                                                        \\r
 177                 __asm( "staa 0x30" ); /* 0x30 = PPAGE */                                        \\r
 178         }\r
 179 \r
 180         /*\r
 181          * By the time this macro is called the processor has already stacked the\r
 182          * registers.  Simply stack the nesting count and PPAGE value, then save\r
 183          * the task stack pointer.\r
 184          */\r
 185         #define portSAVE_CONTEXT()                                                                              \\r
 186         {                                                                                                                               \\r
 187                 extern volatile void * pxCurrentTCB;                                            \\r
 188                 extern volatile UBaseType_t uxCriticalNesting;  \\r
 189                                                                                                                                         \\r
 190                 __asm( "ldaa 0x30" );  /* 0x30 = PPAGE */                                       \\r
 191                 __asm( "psha" );                                                                                        \\r
 192                 __asm( "ldaa uxCriticalNesting" );                                                      \\r
 193                 __asm( "psha" );                                                                                        \\r
 194                 __asm( "ldx pxCurrentTCB" );                                                            \\r
 195                 __asm( "sts 0, x" );                                                                            \\r
 196         }\r
 197 #else\r
 198 \r
 199         /*\r
 200          * These macros are as per the BANKED versions above, but without saving\r
 201          * and restoring the PPAGE register.\r
 202          */\r
 203 \r
 204         #define portRESTORE_CONTEXT()                                                                   \\r
 205         {                                                                                                                               \\r
 206                 extern volatile void * pxCurrentTCB;                                            \\r
 207                 extern volatile UBaseType_t uxCriticalNesting;  \\r
 208                                                                                                                                         \\r
 209                 __asm( "ldx pxCurrentTCB" );                                                            \\r
 210                 __asm( "lds 0, x" );                                                                            \\r
 211                 __asm( "pula" );                                                                                        \\r
 212                 __asm( "staa uxCriticalNesting" );                                                      \\r
 213         }\r
 214 \r
 215         #define portSAVE_CONTEXT()                                                                              \\r
 216         {                                                                                                                               \\r
 217                 extern volatile void * pxCurrentTCB;                                            \\r
 218                 extern volatile UBaseType_t uxCriticalNesting;  \\r
 219                                                                                                                                         \\r
 220                 __asm( "ldaa uxCriticalNesting" );                                                      \\r
 221                 __asm( "psha" );                                                                                        \\r
 222                 __asm( "ldx pxCurrentTCB" );                                                            \\r
 223                 __asm( "sts 0, x" );                                                                            \\r
 224         }\r
 225 #endif\r
 226 \r
 227 /*\r
 228  * Utility macro to call macros above in correct order in order to perform a\r
 229  * task switch from within a standard ISR.  This macro can only be used if\r
 230  * the ISR does not use any local (stack) variables.  If the ISR uses stack\r
 231  * variables portYIELD() should be used in it's place.\r
 232  */\r
 233 #define portTASK_SWITCH_FROM_ISR()                                                              \\r
 234         portSAVE_CONTEXT();                                                                                     \\r
 235         vTaskSwitchContext();                                                                           \\r
 236         portRESTORE_CONTEXT();\r
 237 \r
 238 \r
 239 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 240 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 241 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 242 \r
 243 #endif /* PORTMACRO_H */\r
 244 \r