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

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