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

   1 /*\r
   2     FreeRTOS V7.0.0 - Copyright (C) 2011 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43 \r
  44     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 \r
  55 #ifndef PORTMACRO_H\r
  56 #define PORTMACRO_H\r
  57 \r
  58 #ifdef __cplusplus\r
  59 extern "C" {\r
  60 #endif\r
  61 \r
  62 /*-----------------------------------------------------------\r
  63  * Port specific definitions.  \r
  64  *\r
  65  * The settings in this file configure FreeRTOS correctly for the\r
  66  * given hardware and compiler.\r
  67  *\r
  68  * These settings should not be altered.\r
  69  *-----------------------------------------------------------\r
  70  */\r
  71 \r
  72 /* Type definitions. */\r
  73 #define portCHAR                char\r
  74 #define portFLOAT               float\r
  75 #define portDOUBLE              double\r
  76 #define portLONG                long\r
  77 #define portSHORT               short\r
  78 #define portSTACK_TYPE  unsigned portCHAR\r
  79 #define portBASE_TYPE   char\r
  80 \r
  81 #if( configUSE_16_BIT_TICKS == 1 )\r
  82         typedef unsigned portSHORT portTickType;\r
  83         #define portMAX_DELAY ( portTickType ) 0xffff\r
  84 #else\r
  85         typedef unsigned portLONG portTickType;\r
  86         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
  87 #endif\r
  88 /*-----------------------------------------------------------*/\r
  89 \r
  90 /* Hardware specifics. */\r
  91 #define portBYTE_ALIGNMENT                      1\r
  92 #define portSTACK_GROWTH                        ( -1 )\r
  93 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )\r
  94 #define portYIELD()                                     __asm( "swi" );\r
  95 /*-----------------------------------------------------------*/\r
  96 \r
  97 /* Critical section handling. */\r
  98 #define portENABLE_INTERRUPTS()                         __asm( "cli" )  \r
  99 #define portDISABLE_INTERRUPTS()                        __asm( "sei" )\r
 100 \r
 101 /*\r
 102  * Disable interrupts before incrementing the count of critical section nesting.\r
 103  * The nesting count is maintained so we know when interrupts should be\r
 104  * re-enabled.  Once interrupts are disabled the nesting count can be accessed\r
 105  * directly.  Each task maintains its own nesting count.\r
 106  */\r
 107 #define portENTER_CRITICAL()                                                                    \\r
 108 {                                                                                                                               \\r
 109         extern volatile unsigned portBASE_TYPE uxCriticalNesting;       \\r
 110                                                                                                                                 \\r
 111         portDISABLE_INTERRUPTS();                                                                       \\r
 112         uxCriticalNesting++;                                                                            \\r
 113 }\r
 114 \r
 115 /*\r
 116  * Interrupts are disabled so we can access the nesting count directly.  If the\r
 117  * nesting is found to be 0 (no nesting) then we are leaving the critical \r
 118  * section and interrupts can be re-enabled.\r
 119  */\r
 120 #define  portEXIT_CRITICAL()                                                                    \\r
 121 {                                                                                                                               \\r
 122         extern volatile unsigned portBASE_TYPE uxCriticalNesting;       \\r
 123                                                                                                                                 \\r
 124         uxCriticalNesting--;                                                                            \\r
 125         if( uxCriticalNesting == 0 )                                                            \\r
 126         {                                                                                                                       \\r
 127                 portENABLE_INTERRUPTS();                                                                \\r
 128         }                                                                                                                       \\r
 129 }\r
 130 /*-----------------------------------------------------------*/\r
 131 \r
 132 /* Task utilities. */\r
 133 \r
 134 /* \r
 135  * These macros are very simple as the processor automatically saves and \r
 136  * restores its registers as interrupts are entered and exited.  In\r
 137  * addition to the (automatically stacked) registers we also stack the \r
 138  * critical nesting count.  Each task maintains its own critical nesting\r
 139  * count as it is legitimate for a task to yield from within a critical\r
 140  * section.  If the banked memory model is being used then the PPAGE\r
 141  * register is also stored as part of the tasks context.\r
 142  */\r
 143 \r
 144 #ifdef BANKED_MODEL\r
 145         /* \r
 146          * Load the stack pointer for the task, then pull the critical nesting\r
 147          * count and PPAGE register from the stack.  The remains of the \r
 148          * context are restored by the RTI instruction.\r
 149          */\r
 150         #define portRESTORE_CONTEXT()                                                   \\r
 151         {                                                                               \\r
 152                 __asm( "                                                                \n\\r
 153                 .globl pxCurrentTCB                     ; void *                        \n\\r
 154                 .globl uxCriticalNesting                ; char                          \n\\r
 155                                                                                         \n\\r
 156                 ldx  pxCurrentTCB                                                       \n\\r
 157                 lds  0,x                                ; Stack                         \n\\r
 158                                                                                         \n\\r
 159                 movb 1,sp+,uxCriticalNesting                                            \n\\r
 160                 movb 1,sp+,0x30                         ; PPAGE                         \n\\r
 161                 " );                                                                    \\r
 162         }\r
 163 \r
 164         /* \r
 165          * By the time this macro is called the processor has already stacked the\r
 166          * registers.  Simply stack the nesting count and PPAGE value, then save \r
 167          * the task stack pointer.\r
 168          */\r
 169         #define portSAVE_CONTEXT()                                                      \\r
 170         {                                                                               \\r
 171                 __asm( "                                                                \n\\r
 172                 .globl pxCurrentTCB                     ; void *                        \n\\r
 173                 .globl uxCriticalNesting                ; char                          \n\\r
 174                                                                                         \n\\r
 175                 movb 0x30, 1,-sp                        ; PPAGE                         \n\\r
 176                 movb uxCriticalNesting, 1,-sp                                           \n\\r
 177                                                                                         \n\\r
 178                 ldx  pxCurrentTCB                                                       \n\\r
 179                 sts  0,x                                ; Stack                         \n\\r
 180                 " );                                                                    \\r
 181         }\r
 182 #else\r
 183 \r
 184         /* \r
 185          * These macros are as per the BANKED versions above, but without saving\r
 186          * and restoring the PPAGE register.\r
 187          */\r
 188 \r
 189         #define portRESTORE_CONTEXT()                                                   \\r
 190         {                                                                               \\r
 191                 __asm( "                                                                \n\\r
 192                 .globl pxCurrentTCB                     ; void *                        \n\\r
 193                 .globl uxCriticalNesting                ; char                          \n\\r
 194                                                                                         \n\\r
 195                 ldx  pxCurrentTCB                                                       \n\\r
 196                 lds  0,x                                ; Stack                         \n\\r
 197                                                                                         \n\\r
 198                 movb 1,sp+,uxCriticalNesting                                            \n\\r
 199                 " );                                                                    \\r
 200         }\r
 201 \r
 202         #define portSAVE_CONTEXT()                                                      \\r
 203         {                                                                               \\r
 204                 __asm( "                                                                \n\\r
 205                 .globl pxCurrentTCB                     ; void *                        \n\\r
 206                 .globl uxCriticalNesting                ; char                          \n\\r
 207                                                                                         \n\\r
 208                 movb uxCriticalNesting, 1,-sp                                           \n\\r
 209                                                                                         \n\\r
 210                 ldx  pxCurrentTCB                                                       \n\\r
 211                 sts  0,x                                ; Stack                         \n\\r
 212                 " );                                                                    \\r
 213         }\r
 214 #endif\r
 215 \r
 216 /*\r
 217  * Utility macros to save/restore correct software registers for GCC. This is\r
 218  * useful when GCC does not generate appropriate ISR head/tail code.\r
 219  */\r
 220 #define portISR_HEAD()                                                                  \\r
 221 {                                                                                       \\r
 222                 __asm("                                                                 \n\\r
 223                 movw _.frame, 2,-sp                                                     \n\\r
 224                 movw _.tmp, 2,-sp                                                       \n\\r
 225                 movw _.z, 2,-sp                                                         \n\\r
 226                 movw _.xy, 2,-sp                                                        \n\\r
 227                 ;movw _.d2, 2,-sp                                                       \n\\r
 228                 ;movw _.d1, 2,-sp                                                       \n\\r
 229                 ");                                                                     \\r
 230 }\r
 231 \r
 232 #define portISR_TAIL()                                                                  \\r
 233 {                                                                                       \\r
 234                 __asm("                                                                 \n\\r
 235                 movw 2,sp+, _.xy                                                        \n\\r
 236                 movw 2,sp+, _.z                                                         \n\\r
 237                 movw 2,sp+, _.tmp                                                       \n\\r
 238                 movw 2,sp+, _.frame                                                     \n\\r
 239                 ;movw 2,sp+, _.d1                                                       \n\\r
 240                 ;movw 2,sp+, _.d2                                                       \n\\r
 241                 rti                                                                     \n\\r
 242                 ");                                                                     \\r
 243 }\r
 244 \r
 245 /*\r
 246  * Utility macro to call macros above in correct order in order to perform a\r
 247  * task switch from within a standard ISR.  This macro can only be used if\r
 248  * the ISR does not use any local (stack) variables.  If the ISR uses stack\r
 249  * variables portYIELD() should be used in it's place.\r
 250  */\r
 251 \r
 252 #define portTASK_SWITCH_FROM_ISR()                                                              \\r
 253         portSAVE_CONTEXT();                                                                                     \\r
 254         vTaskSwitchContext();                                                                           \\r
 255         portRESTORE_CONTEXT();\r
 256 \r
 257 \r
 258 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 259 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 260 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 261 \r
 262 #ifdef __cplusplus\r
 263 }\r
 264 #endif\r
 265 \r
 266 #endif /* PORTMACRO_H */\r
 267 \r