git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/RVDS/ARM_CA9/portmacro.h

   1 /*\r
   2  * FreeRTOS Kernel V10.3.0\r
   3  * Copyright (C) 2020 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 #ifndef PORTMACRO_H\r
  29 #define PORTMACRO_H\r
  30 \r
  31 #ifdef __cplusplus\r
  32 extern "C" {\r
  33 #endif\r
  34 \r
  35 /*-----------------------------------------------------------\r
  36  * Port specific definitions.\r
  37  *\r
  38  * The settings in this file configure FreeRTOS correctly for the given hardware\r
  39  * and compiler.\r
  40  *\r
  41  * These settings should not be altered.\r
  42  *-----------------------------------------------------------\r
  43  */\r
  44 \r
  45 /* Type definitions. */\r
  46 #define portCHAR                char\r
  47 #define portFLOAT               float\r
  48 #define portDOUBLE              double\r
  49 #define portLONG                long\r
  50 #define portSHORT               short\r
  51 #define portSTACK_TYPE  uint32_t\r
  52 #define portBASE_TYPE   long\r
  53 \r
  54 typedef portSTACK_TYPE StackType_t;\r
  55 typedef long BaseType_t;\r
  56 typedef unsigned long UBaseType_t;\r
  57 \r
  58 \r
  59 #if( configUSE_16_BIT_TICKS == 1 )\r
  60         typedef uint16_t TickType_t;\r
  61         #define portMAX_DELAY ( TickType_t ) 0xffff\r
  62 #else\r
  63         typedef uint32_t TickType_t;\r
  64         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
  65 \r
  66         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
  67         not need to be guarded with a critical section. */\r
  68         #define portTICK_TYPE_IS_ATOMIC 1\r
  69 #endif\r
  70 /*-----------------------------------------------------------*/\r
  71 \r
  72 /* Hardware specifics. */\r
  73 #define portSTACK_GROWTH                        ( -1 )\r
  74 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  75 #define portBYTE_ALIGNMENT                      8\r
  76 \r
  77 /*-----------------------------------------------------------*/\r
  78 \r
  79 /* Task utilities. */\r
  80 \r
  81 /* Called at the end of an ISR that can cause a context switch. */\r
  82 #define portEND_SWITCHING_ISR( xSwitchRequired )\\r
  83 {                                                                                               \\r
  84 extern uint32_t ulPortYieldRequired;                    \\r
  85                                                                                                 \\r
  86         if( xSwitchRequired != pdFALSE )                        \\r
  87         {                                                                                       \\r
  88                 ulPortYieldRequired = pdTRUE;                   \\r
  89         }                                                                                       \\r
  90 }\r
  91 \r
  92 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
  93 #define portYIELD() __asm( "SWI 0" );\r
  94 \r
  95 \r
  96 /*-----------------------------------------------------------\r
  97  * Critical section control\r
  98  *----------------------------------------------------------*/\r
  99 \r
 100 extern void vPortEnterCritical( void );\r
 101 extern void vPortExitCritical( void );\r
 102 extern uint32_t ulPortSetInterruptMask( void );\r
 103 extern void vPortClearInterruptMask( uint32_t ulNewMaskValue );\r
 104 \r
 105 /* These macros do not globally disable/enable interrupts.  They do mask off\r
 106 interrupts that have a priority below configMAX_API_CALL_INTERRUPT_PRIORITY. */\r
 107 #define portENTER_CRITICAL()            vPortEnterCritical();\r
 108 #define portEXIT_CRITICAL()                     vPortExitCritical();\r
 109 #define portDISABLE_INTERRUPTS()        ulPortSetInterruptMask()\r
 110 #define portENABLE_INTERRUPTS()         vPortClearInterruptMask( 0 )\r
 111 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortSetInterruptMask()\r
 112 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortClearInterruptMask(x)\r
 113 \r
 114 /*-----------------------------------------------------------*/\r
 115 \r
 116 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 117 not required for this port but included in case common demo code that uses these\r
 118 macros is used. */\r
 119 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )      void vFunction( void *pvParameters )\r
 120 #define portTASK_FUNCTION( vFunction, pvParameters )    void vFunction( void *pvParameters )\r
 121 \r
 122 /* Prototype of the FreeRTOS tick handler.  This must be installed as the\r
 123 handler for whichever peripheral is used to generate the RTOS tick. */\r
 124 void FreeRTOS_Tick_Handler( void );\r
 125 \r
 126 /* Any task that uses the floating point unit MUST call vPortTaskUsesFPU()\r
 127 before any floating point instructions are executed. */\r
 128 void vPortTaskUsesFPU( void );\r
 129 #define portTASK_USES_FLOATING_POINT() vPortTaskUsesFPU()\r
 130 \r
 131 #define portLOWEST_INTERRUPT_PRIORITY ( ( ( uint32_t ) configUNIQUE_INTERRUPT_PRIORITIES ) - 1UL )\r
 132 #define portLOWEST_USABLE_INTERRUPT_PRIORITY ( portLOWEST_INTERRUPT_PRIORITY - 1UL )\r
 133 \r
 134 /* Architecture specific optimisations. */\r
 135 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 136         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 137 #endif\r
 138 \r
 139 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 140 \r
 141         /* Store/clear the ready priorities in a bit map. */\r
 142         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 143         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 144 \r
 145         /*-----------------------------------------------------------*/\r
 146 \r
 147         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - __clz( uxReadyPriorities ) )\r
 148 \r
 149 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 150 \r
 151 #ifdef configASSERT\r
 152         void vPortValidateInterruptPriority( void );\r
 153         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()      vPortValidateInterruptPriority()\r
 154 #endif\r
 155 \r
 156 #define portNOP() __nop()\r
 157 \r
 158 #ifdef __cplusplus\r
 159 }\r
 160 #endif\r
 161 \r
 162 #endif /* PORTMACRO_H */\r
 163 \r