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

   1 /*\r
   2     FreeRTOS V8.2.2 - Copyright (C) 2015 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     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 #ifndef PORTMACRO_H\r
  71 #define PORTMACRO_H\r
  72 \r
  73 #ifdef __cplusplus\r
  74 extern "C" {\r
  75 #endif\r
  76 \r
  77 /*-----------------------------------------------------------\r
  78  * Port specific definitions.\r
  79  *\r
  80  * The settings in this file configure FreeRTOS correctly for the given hardware\r
  81  * and compiler.\r
  82  *\r
  83  * These settings should not be altered.\r
  84  *-----------------------------------------------------------\r
  85  */\r
  86 \r
  87 /* Type definitions. */\r
  88 #define portCHAR                char\r
  89 #define portFLOAT               float\r
  90 #define portDOUBLE              double\r
  91 #define portLONG                long\r
  92 #define portSHORT               short\r
  93 #define portSTACK_TYPE  uint32_t\r
  94 #define portBASE_TYPE   long\r
  95 \r
  96 typedef portSTACK_TYPE StackType_t;\r
  97 typedef long BaseType_t;\r
  98 typedef unsigned long UBaseType_t;\r
  99 \r
 100 \r
 101 #if( configUSE_16_BIT_TICKS == 1 )\r
 102         typedef uint16_t TickType_t;\r
 103         #define portMAX_DELAY ( TickType_t ) 0xffff\r
 104 #else\r
 105         typedef uint32_t TickType_t;\r
 106         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
 107 \r
 108         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
 109         not need to be guarded with a critical section. */\r
 110         #define portTICK_TYPE_IS_ATOMIC 1\r
 111 #endif\r
 112 /*-----------------------------------------------------------*/\r
 113 \r
 114 /* Hardware specifics. */\r
 115 #define portSTACK_GROWTH                        ( -1 )\r
 116 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 117 #define portBYTE_ALIGNMENT                      8\r
 118 \r
 119 /*-----------------------------------------------------------*/\r
 120 \r
 121 /* Task utilities. */\r
 122 \r
 123 /* Called at the end of an ISR that can cause a context switch. */\r
 124 #define portEND_SWITCHING_ISR( xSwitchRequired )\\r
 125 {                                                                                               \\r
 126 extern uint32_t ulPortYieldRequired;                    \\r
 127                                                                                                 \\r
 128         if( xSwitchRequired != pdFALSE )                        \\r
 129         {                                                                                       \\r
 130                 ulPortYieldRequired = pdTRUE;                   \\r
 131         }                                                                                       \\r
 132 }\r
 133 \r
 134 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
 135 #define portYIELD() __asm( "SWI 0" );\r
 136 \r
 137 \r
 138 /*-----------------------------------------------------------\r
 139  * Critical section control\r
 140  *----------------------------------------------------------*/\r
 141 \r
 142 extern void vPortEnterCritical( void );\r
 143 extern void vPortExitCritical( void );\r
 144 extern uint32_t ulPortSetInterruptMask( void );\r
 145 extern void vPortClearInterruptMask( uint32_t ulNewMaskValue );\r
 146 \r
 147 /* These macros do not globally disable/enable interrupts.  They do mask off\r
 148 interrupts that have a priority below configMAX_API_CALL_INTERRUPT_PRIORITY. */\r
 149 #define portENTER_CRITICAL()            vPortEnterCritical();\r
 150 #define portEXIT_CRITICAL()                     vPortExitCritical();\r
 151 #define portDISABLE_INTERRUPTS()        ulPortSetInterruptMask()\r
 152 #define portENABLE_INTERRUPTS()         vPortClearInterruptMask( 0 )\r
 153 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortSetInterruptMask()\r
 154 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortClearInterruptMask(x)\r
 155 \r
 156 /*-----------------------------------------------------------*/\r
 157 \r
 158 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 159 not required for this port but included in case common demo code that uses these\r
 160 macros is used. */\r
 161 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )      void vFunction( void *pvParameters )\r
 162 #define portTASK_FUNCTION( vFunction, pvParameters )    void vFunction( void *pvParameters )\r
 163 \r
 164 /* Prototype of the FreeRTOS tick handler.  This must be installed as the\r
 165 handler for whichever peripheral is used to generate the RTOS tick. */\r
 166 void FreeRTOS_Tick_Handler( void );\r
 167 \r
 168 /* Any task that uses the floating point unit MUST call vPortTaskUsesFPU()\r
 169 before any floating point instructions are executed. */\r
 170 void vPortTaskUsesFPU( void );\r
 171 #define portTASK_USES_FLOATING_POINT() vPortTaskUsesFPU()\r
 172 \r
 173 #define portLOWEST_INTERRUPT_PRIORITY ( ( ( uint32_t ) configUNIQUE_INTERRUPT_PRIORITIES ) - 1UL )\r
 174 #define portLOWEST_USABLE_INTERRUPT_PRIORITY ( portLOWEST_INTERRUPT_PRIORITY - 1UL )\r
 175 \r
 176 /* Architecture specific optimisations. */\r
 177 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 178         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 179 #endif\r
 180 \r
 181 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 182 \r
 183         /* Store/clear the ready priorities in a bit map. */\r
 184         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 185         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 186 \r
 187         /*-----------------------------------------------------------*/\r
 188 \r
 189         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - __clz( uxReadyPriorities ) )\r
 190 \r
 191 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 192 \r
 193 #ifdef configASSERT\r
 194         void vPortValidateInterruptPriority( void );\r
 195         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()      vPortValidateInterruptPriority()\r
 196 #endif\r
 197 \r
 198 #define portNOP() __nop()\r
 199 \r
 200 #ifdef __cplusplus\r
 201 }\r
 202 #endif\r
 203 \r
 204 #endif /* PORTMACRO_H */\r
 205 \r