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

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