git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/IAR/RL78/portmacro.h

   1 /*\r
   2     FreeRTOS V7.2.0 - Copyright (C) 2012 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     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 #ifndef PORTMACRO_H\r
  68 #define PORTMACRO_H\r
  69 \r
  70 #ifdef __cplusplus\r
  71 extern "C" {\r
  72 #endif\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 #if __DATA_MODEL__ == __DATA_MODEL_FAR__ && __CODE_MODEL__ == __CODE_MODEL_NEAR__\r
  85         #warning This port has not been tested with your selected memory model combination. If a far data model is required it is recommended to also use a far code model.\r
  86 #endif\r
  87 \r
  88 #if __DATA_MODEL__ == __DATA_MODEL_NEAR__ && __CODE_MODEL__ == __CODE_MODEL_FAR__\r
  89         #warning This port has not been tested with your selected memory model combination. If a far code model is required it is recommended to also use a far data model.\r
  90 #endif\r
  91         \r
  92 /* Type definitions. */\r
  93 \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 short\r
 100 #define portBASE_TYPE   short\r
 101 \r
 102 #if __DATA_MODEL__ == __DATA_MODEL_FAR__\r
 103         #define portPOINTER_SIZE_TYPE unsigned long\r
 104 #else\r
 105         #define portPOINTER_SIZE_TYPE unsigned short\r
 106 #endif\r
 107 \r
 108         \r
 109 #if ( configUSE_16_BIT_TICKS == 1 )\r
 110         typedef unsigned int portTickType;\r
 111         #define portMAX_DELAY ( portTickType ) 0xffff\r
 112 #else\r
 113         typedef unsigned long portTickType;\r
 114         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
 115 #endif\r
 116 /*-----------------------------------------------------------*/ \r
 117 \r
 118 /* Interrupt control macros. */\r
 119 #define portDISABLE_INTERRUPTS() __asm ( "DI" )\r
 120 #define portENABLE_INTERRUPTS()  __asm ( "EI" )\r
 121 /*-----------------------------------------------------------*/\r
 122 \r
 123 /* Critical section control macros. */\r
 124 #define portNO_CRITICAL_SECTION_NESTING         ( ( unsigned portSHORT ) 0 )\r
 125 \r
 126 #define portENTER_CRITICAL()                                                                                                    \\r
 127 {                                                                                                                                                               \\r
 128 extern volatile unsigned short usCriticalNesting;                                                               \\r
 129                                                                                                                                                                 \\r
 130         portDISABLE_INTERRUPTS();                                                                                                       \\r
 131                                                                                                                                                                 \\r
 132         /* Now interrupts are disabled ulCriticalNesting can be accessed */                     \\r
 133         /* directly.  Increment ulCriticalNesting to keep a count of how many */        \\r
 134         /* times portENTER_CRITICAL() has been called. */                                                       \\r
 135         usCriticalNesting++;                                                                                                            \\r
 136 }\r
 137 \r
 138 #define portEXIT_CRITICAL()                                                                                                             \\r
 139 {                                                                                                                                                               \\r
 140 extern volatile unsigned short usCriticalNesting;                                                               \\r
 141                                                                                                                                                                 \\r
 142         if( usCriticalNesting > portNO_CRITICAL_SECTION_NESTING )                                       \\r
 143         {                                                                                                                                                       \\r
 144                 /* Decrement the nesting count as we are leaving a critical section. */ \\r
 145                 usCriticalNesting--;                                                                                                    \\r
 146                                                                                                                                                                 \\r
 147                 /* If the nesting level has reached zero then interrupts should be */   \\r
 148                 /* re-enabled. */                                                                                                               \\r
 149                 if( usCriticalNesting == portNO_CRITICAL_SECTION_NESTING )                              \\r
 150                 {                                                                                                                                               \\r
 151                         portENABLE_INTERRUPTS();                                                                                        \\r
 152                 }                                                                                                                                               \\r
 153         }                                                                                                                                                       \\r
 154 }\r
 155 /*-----------------------------------------------------------*/\r
 156 \r
 157 /* Task utilities. */\r
 158 #define portYIELD()     __asm( "BRK" )\r
 159 #define portYIELD_FROM_ISR( xHigherPriorityTaskWoken ) if( xHigherPriorityTaskWoken ) vTaskSwitchContext()\r
 160 #define portNOP()       __asm( "NOP" )\r
 161 /*-----------------------------------------------------------*/\r
 162 \r
 163 /* Hardwware specifics. */\r
 164 #define portBYTE_ALIGNMENT      2\r
 165 #define portSTACK_GROWTH        ( -1 )\r
 166 #define portTICK_RATE_MS        ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
 167 /*-----------------------------------------------------------*/\r
 168 \r
 169 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 170 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 171 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 172 \r
 173 /* --------------------------------------------------------------------------*/\r
 174 /* Option-bytes and security ID                                              */\r
 175 /* --------------------------------------------------------------------------*/\r
 176 #define OPT_BYTES_SIZE     4\r
 177 #define SECU_ID_SIZE       10\r
 178 #define WATCHDOG_DISABLED  0x00\r
 179 #define LVI_ENABLED        0xFE\r
 180 #define LVI_DISABLED       0xFF\r
 181 #define RESERVED_FF        0xFF\r
 182 #define OCD_DISABLED       0x04\r
 183 #define OCD_ENABLED        0x81\r
 184 #define OCD_ENABLED_ERASE  0x80\r
 185 \r
 186 #ifdef __cplusplus\r
 187 }\r
 188 #endif\r
 189 \r
 190 #endif /* PORTMACRO_H */\r
 191 \r