git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/Renesas/SH2A_FPU/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 #include <machine.h>\r
  80 \r
  81 #ifdef __cplusplus\r
  82 extern "C" {\r
  83 #endif\r
  84 \r
  85 /*-----------------------------------------------------------\r
  86  * Port specific definitions.  \r
  87  *\r
  88  * The settings in this file configure FreeRTOS correctly for the\r
  89  * given hardware and compiler.\r
  90  *\r
  91  * These settings should not be altered.\r
  92  *-----------------------------------------------------------\r
  93  */\r
  94 \r
  95 /* Type definitions - these are a bit legacy and not really used now, other than\r
  96 portSTACK_TYPE and portBASE_TYPE. */\r
  97 #define portCHAR                char\r
  98 #define portFLOAT               float\r
  99 #define portDOUBLE              double\r
 100 #define portLONG                long\r
 101 #define portSHORT               short\r
 102 #define portSTACK_TYPE  unsigned portLONG\r
 103 #define portBASE_TYPE   long\r
 104 \r
 105 #if( configUSE_16_BIT_TICKS == 1 )\r
 106         typedef unsigned portSHORT portTickType;\r
 107         #define portMAX_DELAY ( portTickType ) 0xffff\r
 108 #else\r
 109         typedef unsigned portLONG portTickType;\r
 110         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
 111 #endif\r
 112 /*-----------------------------------------------------------*/\r
 113 \r
 114 /* Hardware specifics. */\r
 115 #define portBYTE_ALIGNMENT                              8\r
 116 #define portSTACK_GROWTH                                -1\r
 117 #define portTICK_RATE_MS                                ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
 118 #define portNOP()                                               nop()\r
 119 #define portSTART_SCHEDULER_TRAP_NO             ( 32 )\r
 120 #define portYIELD_TRAP_NO                               ( 33 )\r
 121 #define portKERNEL_INTERRUPT_PRIORITY   ( 1 )\r
 122 \r
 123 void vPortYield( void );\r
 124 #define portYIELD()                                             vPortYield()\r
 125 \r
 126 extern void vTaskSwitchContext( void );\r
 127 #define portYIELD_FROM_ISR( x )                 if( x != pdFALSE ) vTaskSwitchContext()\r
 128 \r
 129 /* \r
 130  * This function tells the kernel that the task referenced by xTask is going to \r
 131  * use the floating point registers and therefore requires the floating point \r
 132  * registers saved as part of its context. \r
 133  */\r
 134 portBASE_TYPE xPortUsesFloatingPoint( void* xTask );\r
 135 \r
 136 /*\r
 137  * The flop save and restore functions are defined in portasm.src and called by\r
 138  * the trace "task switched in" and "trace task switched out" macros. \r
 139  */\r
 140 void vPortSaveFlopRegisters( void *pulBuffer );\r
 141 void vPortRestoreFlopRegisters( void *pulBuffer );\r
 142 \r
 143 /*\r
 144  * pxTaskTag is used to point to the buffer into which the floating point \r
 145  * context should be saved.  If pxTaskTag is NULL then the task does not use\r
 146  * a floating point context.\r
 147  */\r
 148 #define traceTASK_SWITCHED_OUT() if( pxCurrentTCB->pxTaskTag != NULL ) vPortSaveFlopRegisters( pxCurrentTCB->pxTaskTag )\r
 149 #define traceTASK_SWITCHED_IN() if( pxCurrentTCB->pxTaskTag != NULL ) vPortRestoreFlopRegisters( pxCurrentTCB->pxTaskTag )\r
 150 \r
 151 /*\r
 152  * These macros should be called directly, but through the taskENTER_CRITICAL()\r
 153  * and taskEXIT_CRITICAL() macros.\r
 154  */\r
 155 #define portENABLE_INTERRUPTS()         set_imask( 0x00 )\r
 156 #define portDISABLE_INTERRUPTS()        set_imask( portKERNEL_INTERRUPT_PRIORITY )\r
 157 \r
 158 /* Critical nesting counts are stored in the TCB. */\r
 159 #define portCRITICAL_NESTING_IN_TCB ( 1 )\r
 160 \r
 161 /* The critical nesting functions defined within tasks.c. */\r
 162 extern void vTaskEnterCritical( void );\r
 163 extern void vTaskExitCritical( void );\r
 164 #define portENTER_CRITICAL()    vTaskEnterCritical();\r
 165 #define portEXIT_CRITICAL()             vTaskExitCritical();\r
 166 \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 #ifdef __cplusplus\r
 174 }\r
 175 #endif\r
 176 \r
 177 #endif /* PORTMACRO_H */\r
 178 \r