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

   1 /*\r
   2  * FreeRTOS Kernel V10.0.0\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 \r
  30 #ifndef PORTMACRO_H\r
  31 #define PORTMACRO_H\r
  32 \r
  33 #include <machine.h>\r
  34 \r
  35 #ifdef __cplusplus\r
  36 extern "C" {\r
  37 #endif\r
  38 \r
  39 /*-----------------------------------------------------------\r
  40  * Port specific definitions.\r
  41  *\r
  42  * The settings in this file configure FreeRTOS correctly for the\r
  43  * given hardware and compiler.\r
  44  *\r
  45  * These settings should not be altered.\r
  46  *-----------------------------------------------------------\r
  47  */\r
  48 \r
  49 /* Type definitions - these are a bit legacy and not really used now, other than\r
  50 portSTACK_TYPE and portBASE_TYPE. */\r
  51 #define portCHAR                char\r
  52 #define portFLOAT               float\r
  53 #define portDOUBLE              double\r
  54 #define portLONG                long\r
  55 #define portSHORT               short\r
  56 #define portSTACK_TYPE  uint32_t\r
  57 #define portBASE_TYPE   long\r
  58 \r
  59 typedef portSTACK_TYPE StackType_t;\r
  60 typedef long BaseType_t;\r
  61 typedef unsigned long UBaseType_t;\r
  62 \r
  63 #if( configUSE_16_BIT_TICKS == 1 )\r
  64         typedef uint16_t TickType_t;\r
  65         #define portMAX_DELAY ( TickType_t ) 0xffff\r
  66 #else\r
  67         typedef uint32_t TickType_t;\r
  68         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
  69 \r
  70         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
  71         not need to be guarded with a critical section. */\r
  72         #define portTICK_TYPE_IS_ATOMIC 1\r
  73 #endif\r
  74 /*-----------------------------------------------------------*/\r
  75 \r
  76 /* Hardware specifics. */\r
  77 #define portBYTE_ALIGNMENT                              8\r
  78 #define portSTACK_GROWTH                                -1\r
  79 #define portTICK_PERIOD_MS                              ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  80 #define portNOP()                                               nop()\r
  81 #define portSTART_SCHEDULER_TRAP_NO             ( 32 )\r
  82 #define portYIELD_TRAP_NO                               ( 33 )\r
  83 #define portKERNEL_INTERRUPT_PRIORITY   ( 1 )\r
  84 \r
  85 void vPortYield( void );\r
  86 #define portYIELD()                                             vPortYield()\r
  87 \r
  88 extern void vTaskSwitchContext( void );\r
  89 #define portYIELD_FROM_ISR( x )                 if( x != pdFALSE ) vTaskSwitchContext()\r
  90 \r
  91 /*\r
  92  * This function tells the kernel that the task referenced by xTask is going to\r
  93  * use the floating point registers and therefore requires the floating point\r
  94  * registers saved as part of its context.\r
  95  */\r
  96 BaseType_t xPortUsesFloatingPoint( void* xTask );\r
  97 \r
  98 /*\r
  99  * The flop save and restore functions are defined in portasm.src and called by\r
 100  * the trace "task switched in" and "trace task switched out" macros.\r
 101  */\r
 102 void vPortSaveFlopRegisters( void *pulBuffer );\r
 103 void vPortRestoreFlopRegisters( void *pulBuffer );\r
 104 \r
 105 /*\r
 106  * pxTaskTag is used to point to the buffer into which the floating point\r
 107  * context should be saved.  If pxTaskTag is NULL then the task does not use\r
 108  * a floating point context.\r
 109  */\r
 110 #define traceTASK_SWITCHED_OUT() if( pxCurrentTCB->pxTaskTag != NULL ) vPortSaveFlopRegisters( pxCurrentTCB->pxTaskTag )\r
 111 #define traceTASK_SWITCHED_IN() if( pxCurrentTCB->pxTaskTag != NULL ) vPortRestoreFlopRegisters( pxCurrentTCB->pxTaskTag )\r
 112 \r
 113 /*\r
 114  * These macros should be called directly, but through the taskENTER_CRITICAL()\r
 115  * and taskEXIT_CRITICAL() macros.\r
 116  */\r
 117 #define portENABLE_INTERRUPTS()         set_imask( 0x00 )\r
 118 #define portDISABLE_INTERRUPTS()        set_imask( portKERNEL_INTERRUPT_PRIORITY )\r
 119 \r
 120 /* Critical nesting counts are stored in the TCB. */\r
 121 #define portCRITICAL_NESTING_IN_TCB ( 1 )\r
 122 \r
 123 /* The critical nesting functions defined within tasks.c. */\r
 124 extern void vTaskEnterCritical( void );\r
 125 extern void vTaskExitCritical( void );\r
 126 #define portENTER_CRITICAL()    vTaskEnterCritical();\r
 127 #define portEXIT_CRITICAL()             vTaskExitCritical();\r
 128 \r
 129 /*-----------------------------------------------------------*/\r
 130 \r
 131 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 132 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 133 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 134 \r
 135 #ifdef __cplusplus\r
 136 }\r
 137 #endif\r
 138 \r
 139 #endif /* PORTMACRO_H */\r
 140 \r