git.sur5r.net Git - freertos/blob - Source/portable/Renesas/RX600/portmacro.h

   1 /*\r
   2     FreeRTOS V6.0.5 - Copyright (C) 2010 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS eBook                                  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\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 exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     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 - these are a bit legacy and not really used now, other than\r
  73 portSTACK_TYPE and portBASE_TYPE. */\r
  74 #define portCHAR                char\r
  75 #define portFLOAT               float\r
  76 #define portDOUBLE              double\r
  77 #define portLONG                long\r
  78 #define portSHORT               short\r
  79 #define portSTACK_TYPE  unsigned portLONG\r
  80 #define portBASE_TYPE   long\r
  81 \r
  82 #if( configUSE_16_BIT_TICKS == 1 )\r
  83         typedef unsigned portSHORT portTickType;\r
  84         #define portMAX_DELAY ( portTickType ) 0xffff\r
  85 #else\r
  86         typedef unsigned portLONG portTickType;\r
  87         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
  88 #endif\r
  89 /*-----------------------------------------------------------*/\r
  90 \r
  91 /* Hardware specifics. */\r
  92 #define portBYTE_ALIGNMENT                              8\r
  93 #define portSTACK_GROWTH                                -1\r
  94 #define portTICK_RATE_MS                                ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
  95 #define portNOP()                                               nop()\r
  96 #define portSTART_SCHEDULER_TRAP_NO             ( 32 )\r
  97 #define portKERNEL_INTERRUPT_PRIORITY   ( 1 )\r
  98 \r
  99 void vPortYield( void );\r
 100 #define portYIELD()                                             vPortYield()\r
 101 \r
 102 extern void vTaskSwitchContext( void );\r
 103 #define portYIELD_FROM_ISR( x )                 if( x != pdFALSE ) vTaskSwitchContext()\r
 104 \r
 105 /* \r
 106  * This function tells the kernel that the task referenced by xTask is going to \r
 107  * use the floating point registers and therefore requires the floating point \r
 108  * registers saved as part of its context. \r
 109  */\r
 110 portBASE_TYPE xPortUsesFloatingPoint( void* xTask );\r
 111 \r
 112 /*\r
 113  * The flop save and restore functions are defined in portasm.src and called by\r
 114  * the trace "task switched in" and "trace task switched out" macros. \r
 115  */\r
 116 void vPortSaveFlopRegisters( void *pulBuffer );\r
 117 void vPortRestoreFlopRegisters( void *pulBuffer );\r
 118 \r
 119 /*\r
 120  * pxTaskTag is used to point to the buffer into which the floating point \r
 121  * context should be saved.  If pxTaskTag is NULL then the task does not use\r
 122  * a floating point context.\r
 123  */\r
 124 #define traceTASK_SWITCHED_OUT() if( pxCurrentTCB->pxTaskTag != NULL ) vPortSaveFlopRegisters( pxCurrentTCB->pxTaskTag )\r
 125 #define traceTASK_SWITCHED_IN() if( pxCurrentTCB->pxTaskTag != NULL ) vPortRestoreFlopRegisters( pxCurrentTCB->pxTaskTag )\r
 126 \r
 127 /*\r
 128  * These macros should be called directly, but through the taskENTER_CRITICAL()\r
 129  * and taskEXIT_CRITICAL() macros.\r
 130  */\r
 131 #define portENABLE_INTERRUPTS()         \r
 132 #define portDISABLE_INTERRUPTS()        \r
 133 \r
 134 /* Critical nesting counts are stored in the TCB. */\r
 135 #define portCRITICAL_NESTING_IN_TCB ( 1 )\r
 136 \r
 137 /* The critical nesting functions defined within tasks.c. */\r
 138 extern void vTaskEnterCritical( void );\r
 139 extern void vTaskExitCritical( void );\r
 140 #define portENTER_CRITICAL()    vTaskEnterCritical();\r
 141 #define portEXIT_CRITICAL()             vTaskExitCritical();\r
 142 \r
 143 /*-----------------------------------------------------------*/\r
 144 \r
 145 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 146 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 147 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 148 \r
 149 #ifdef __cplusplus\r
 150 }\r
 151 #endif\r
 152 \r
 153 #endif /* PORTMACRO_H */\r
 154 \r