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

   1 /*\r
   2     FreeRTOS V8.2.0rc1 - Copyright (C) 2014 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  12 \r
  13     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  14     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  15     >>!   obliged to provide the source code for proprietary components     !<<\r
  16     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  17 \r
  18     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  19     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  20     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  21     link: http://www.freertos.org/a00114.html\r
  22 \r
  23     1 tab == 4 spaces!\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  28      *    not run, what could be wrong?".  Have you defined configASSERT()?  *\r
  29      *                                                                       *\r
  30      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  31      *                                                                       *\r
  32     ***************************************************************************\r
  33 \r
  34     ***************************************************************************\r
  35      *                                                                       *\r
  36      *    FreeRTOS provides completely free yet professionally developed,    *\r
  37      *    robust, strictly quality controlled, supported, and cross          *\r
  38      *    platform software that is more than just the market leader, it     *\r
  39      *    is the industry's de facto standard.                               *\r
  40      *                                                                       *\r
  41      *    Help yourself get started quickly while simultaneously helping     *\r
  42      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  43      *    tutorial book, reference manual, or both:                          *\r
  44      *    http://www.FreeRTOS.org/Documentation                              *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     ***************************************************************************\r
  49      *                                                                       *\r
  50      *   Investing in training allows your team to be as productive as       *\r
  51      *   possible as early as possible, lowering your overall development    *\r
  52      *   cost, and enabling you to bring a more robust product to market     *\r
  53      *   earlier than would otherwise be possible.  Richard Barry is both    *\r
  54      *   the architect and key author of FreeRTOS, and so also the world's   *\r
  55      *   leading authority on what is the world's most popular real time     *\r
  56      *   kernel for deeply embedded MCU designs.  Obtaining your training    *\r
  57      *   from Richard ensures your team will gain directly from his in-depth *\r
  58      *   product knowledge and years of usage experience.  Contact Real Time *\r
  59      *   Engineers Ltd to enquire about the FreeRTOS Masterclass, presented  *\r
  60      *   by Richard Barry:  http://www.FreeRTOS.org/contact\r
  61      *                                                                       *\r
  62     ***************************************************************************\r
  63 \r
  64     ***************************************************************************\r
  65      *                                                                       *\r
  66      *    You are receiving this top quality software for free.  Please play *\r
  67      *    fair and reciprocate by reporting any suspected issues and         *\r
  68      *    participating in the community forum:                              *\r
  69      *    http://www.FreeRTOS.org/support                                    *\r
  70      *                                                                       *\r
  71      *    Thank you!                                                         *\r
  72      *                                                                       *\r
  73     ***************************************************************************\r
  74 \r
  75     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  76     license and Real Time Engineers Ltd. contact details.\r
  77 \r
  78     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  79     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  80     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  81 \r
  82     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  83     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  84 \r
  85     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  86     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  87     licenses offer ticketed support, indemnification and commercial middleware.\r
  88 \r
  89     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  90     engineered and independently SIL3 certified version for use in safety and\r
  91     mission critical applications that require provable dependability.\r
  92 \r
  93     1 tab == 4 spaces!\r
  94 */\r
  95 \r
  96 \r
  97 #ifndef PORTMACRO_H\r
  98 #define PORTMACRO_H\r
  99 \r
 100 #include <machine.h>\r
 101 \r
 102 #ifdef __cplusplus\r
 103 extern "C" {\r
 104 #endif\r
 105 \r
 106 /*-----------------------------------------------------------\r
 107  * Port specific definitions.\r
 108  *\r
 109  * The settings in this file configure FreeRTOS correctly for the\r
 110  * given hardware and compiler.\r
 111  *\r
 112  * These settings should not be altered.\r
 113  *-----------------------------------------------------------\r
 114  */\r
 115 \r
 116 /* Type definitions - these are a bit legacy and not really used now, other than\r
 117 portSTACK_TYPE and portBASE_TYPE. */\r
 118 #define portCHAR                char\r
 119 #define portFLOAT               float\r
 120 #define portDOUBLE              double\r
 121 #define portLONG                long\r
 122 #define portSHORT               short\r
 123 #define portSTACK_TYPE  uint32_t\r
 124 #define portBASE_TYPE   long\r
 125 \r
 126 typedef portSTACK_TYPE StackType_t;\r
 127 typedef long BaseType_t;\r
 128 typedef unsigned long UBaseType_t;\r
 129 \r
 130 #if( configUSE_16_BIT_TICKS == 1 )\r
 131         typedef uint16_t TickType_t;\r
 132         #define portMAX_DELAY ( TickType_t ) 0xffff\r
 133 #else\r
 134         typedef uint32_t TickType_t;\r
 135         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
 136 \r
 137         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
 138         not need to be guarded with a critical section. */\r
 139         #define portTICK_TYPE_IS_ATOMIC 1\r
 140 #endif\r
 141 /*-----------------------------------------------------------*/\r
 142 \r
 143 /* Hardware specifics. */\r
 144 #define portBYTE_ALIGNMENT                              8\r
 145 #define portSTACK_GROWTH                                -1\r
 146 #define portTICK_PERIOD_MS                              ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 147 #define portNOP()                                               nop()\r
 148 #define portSTART_SCHEDULER_TRAP_NO             ( 32 )\r
 149 #define portYIELD_TRAP_NO                               ( 33 )\r
 150 #define portKERNEL_INTERRUPT_PRIORITY   ( 1 )\r
 151 \r
 152 void vPortYield( void );\r
 153 #define portYIELD()                                             vPortYield()\r
 154 \r
 155 extern void vTaskSwitchContext( void );\r
 156 #define portYIELD_FROM_ISR( x )                 if( x != pdFALSE ) vTaskSwitchContext()\r
 157 \r
 158 /*\r
 159  * This function tells the kernel that the task referenced by xTask is going to\r
 160  * use the floating point registers and therefore requires the floating point\r
 161  * registers saved as part of its context.\r
 162  */\r
 163 BaseType_t xPortUsesFloatingPoint( void* xTask );\r
 164 \r
 165 /*\r
 166  * The flop save and restore functions are defined in portasm.src and called by\r
 167  * the trace "task switched in" and "trace task switched out" macros.\r
 168  */\r
 169 void vPortSaveFlopRegisters( void *pulBuffer );\r
 170 void vPortRestoreFlopRegisters( void *pulBuffer );\r
 171 \r
 172 /*\r
 173  * pxTaskTag is used to point to the buffer into which the floating point\r
 174  * context should be saved.  If pxTaskTag is NULL then the task does not use\r
 175  * a floating point context.\r
 176  */\r
 177 #define traceTASK_SWITCHED_OUT() if( pxCurrentTCB->pxTaskTag != NULL ) vPortSaveFlopRegisters( pxCurrentTCB->pxTaskTag )\r
 178 #define traceTASK_SWITCHED_IN() if( pxCurrentTCB->pxTaskTag != NULL ) vPortRestoreFlopRegisters( pxCurrentTCB->pxTaskTag )\r
 179 \r
 180 /*\r
 181  * These macros should be called directly, but through the taskENTER_CRITICAL()\r
 182  * and taskEXIT_CRITICAL() macros.\r
 183  */\r
 184 #define portENABLE_INTERRUPTS()         set_imask( 0x00 )\r
 185 #define portDISABLE_INTERRUPTS()        set_imask( portKERNEL_INTERRUPT_PRIORITY )\r
 186 \r
 187 /* Critical nesting counts are stored in the TCB. */\r
 188 #define portCRITICAL_NESTING_IN_TCB ( 1 )\r
 189 \r
 190 /* The critical nesting functions defined within tasks.c. */\r
 191 extern void vTaskEnterCritical( void );\r
 192 extern void vTaskExitCritical( void );\r
 193 #define portENTER_CRITICAL()    vTaskEnterCritical();\r
 194 #define portEXIT_CRITICAL()             vTaskExitCritical();\r
 195 \r
 196 /*-----------------------------------------------------------*/\r
 197 \r
 198 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 199 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 200 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 201 \r
 202 #ifdef __cplusplus\r
 203 }\r
 204 #endif\r
 205 \r
 206 #endif /* PORTMACRO_H */\r
 207 \r