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

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