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

   1 /*\r
   2     FreeRTOS V8.1.2 - 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     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 \r
  67 #ifndef PORTMACRO_H\r
  68 #define PORTMACRO_H\r
  69 \r
  70 #ifdef __cplusplus\r
  71 extern "C" {\r
  72 #endif\r
  73 \r
  74 /*-----------------------------------------------------------\r
  75  * Port specific definitions.\r
  76  *\r
  77  * The settings in this file configure FreeRTOS correctly for the\r
  78  * given hardware and compiler.\r
  79  *\r
  80  * These settings should not be altered.\r
  81  *-----------------------------------------------------------\r
  82  */\r
  83 \r
  84 /* Type definitions. */\r
  85 #define portCHAR                char\r
  86 #define portFLOAT               float\r
  87 #define portDOUBLE              double\r
  88 #define portLONG                long\r
  89 #define portSHORT               short\r
  90 #define portSTACK_TYPE  uint32_t\r
  91 #define portBASE_TYPE   long\r
  92 \r
  93 typedef portSTACK_TYPE StackType_t;\r
  94 typedef long BaseType_t;\r
  95 typedef unsigned long UBaseType_t;\r
  96 \r
  97 #if( configUSE_16_BIT_TICKS == 1 )\r
  98         typedef uint16_t TickType_t;\r
  99         #define portMAX_DELAY ( TickType_t ) 0xffff\r
 100 #else\r
 101         typedef uint32_t TickType_t;\r
 102         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
 103 \r
 104         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
 105         not need to be guarded with a critical section. */\r
 106         #define portTICK_TYPE_IS_ATOMIC 1\r
 107 #endif\r
 108 /*-----------------------------------------------------------*/\r
 109 \r
 110 /* Architecture specifics. */\r
 111 #define portSTACK_GROWTH                        ( -1 )\r
 112 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 113 #define portBYTE_ALIGNMENT                      8\r
 114 \r
 115 /* Constants used with memory barrier intrinsics. */\r
 116 #define portSY_FULL_READ_WRITE          ( 15 )\r
 117 \r
 118 /*-----------------------------------------------------------*/\r
 119 \r
 120 /* Scheduler utilities. */\r
 121 #define portNVIC_INT_CTRL_REG           ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )\r
 122 #define portNVIC_PENDSVSET_BIT          ( 1UL << 28UL )\r
 123 #define portYIELD()                                     vPortYield()\r
 124 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired != pdFALSE ) vPortYield()\r
 125 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
 126 /*-----------------------------------------------------------*/\r
 127 \r
 128 /* Critical section management. */\r
 129 extern void vPortEnterCritical( void );\r
 130 extern void vPortExitCritical( void );\r
 131 \r
 132 #define portDISABLE_INTERRUPTS()                                ulPortRaiseBASEPRI()\r
 133 #define portENABLE_INTERRUPTS()                                 vPortSetBASEPRI( 0 )\r
 134 #define portENTER_CRITICAL()                                    vPortEnterCritical()\r
 135 #define portEXIT_CRITICAL()                                             vPortExitCritical()\r
 136 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortRaiseBASEPRI()\r
 137 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortSetBASEPRI(x)\r
 138 \r
 139 /*-----------------------------------------------------------*/\r
 140 \r
 141 /* Tickless idle/low power functionality. */\r
 142 #ifndef portSUPPRESS_TICKS_AND_SLEEP\r
 143         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );\r
 144         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )\r
 145 #endif\r
 146 /*-----------------------------------------------------------*/\r
 147 \r
 148 /* Port specific optimisations. */\r
 149 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 150         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 151 #endif\r
 152 \r
 153 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 154 \r
 155         /* Check the configuration. */\r
 156         #if( configMAX_PRIORITIES > 32 )\r
 157                 #error configUSE_PORT_OPTIMISED_TASK_SELECTION can only be set to 1 when configMAX_PRIORITIES is less than or equal to 32.  It is very rare that a system requires more than 10 to 15 difference priorities as tasks that share a priority will time slice.\r
 158         #endif\r
 159 \r
 160         /* Store/clear the ready priorities in a bit map. */\r
 161         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 162         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 163 \r
 164         /*-----------------------------------------------------------*/\r
 165 \r
 166         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - __clz( ( uxReadyPriorities ) ) )\r
 167 \r
 168 #endif /* taskRECORD_READY_PRIORITY */\r
 169 /*-----------------------------------------------------------*/\r
 170 \r
 171 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 172 not necessary for to use this port.  They are defined so the common demo files\r
 173 (which build with all the ports) will build. */\r
 174 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 175 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 176 /*-----------------------------------------------------------*/\r
 177 \r
 178 #ifdef configASSERT\r
 179         void vPortValidateInterruptPriority( void );\r
 180         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()      vPortValidateInterruptPriority()\r
 181 #endif\r
 182 \r
 183 /* portNOP() is not required by this port. */\r
 184 #define portNOP()\r
 185 \r
 186 #ifndef portFORCE_INLINE\r
 187         #define portFORCE_INLINE __forceinline\r
 188 #endif\r
 189 \r
 190 /*-----------------------------------------------------------*/\r
 191 \r
 192 static portFORCE_INLINE void vPortSetBASEPRI( uint32_t ulBASEPRI )\r
 193 {\r
 194         __asm\r
 195         {\r
 196                 /* Barrier instructions are not used as this function is only used to\r
 197                 lower the BASEPRI value. */\r
 198                 msr basepri, ulBASEPRI\r
 199         }\r
 200 }\r
 201 /*-----------------------------------------------------------*/\r
 202 \r
 203 static portFORCE_INLINE uint32_t ulPortRaiseBASEPRI( void )\r
 204 {\r
 205 uint32_t ulReturn, ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
 206 \r
 207         __asm\r
 208         {\r
 209                 /* Set BASEPRI to the max syscall priority to effect a critical\r
 210                 section. */\r
 211                 mrs ulReturn, basepri\r
 212                 msr basepri, ulNewBASEPRI\r
 213                 dsb\r
 214                 isb\r
 215         }\r
 216 \r
 217         return ulReturn;\r
 218 }\r
 219 /*-----------------------------------------------------------*/\r
 220 \r
 221 static portFORCE_INLINE void vPortYield( void )\r
 222 {\r
 223         /* Set a PendSV to request a context switch. */\r
 224         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
 225 \r
 226         /* Barriers are normally not required but do ensure the code is completely\r
 227         within the specified behaviour for the architecture. */\r
 228         __dsb( portSY_FULL_READ_WRITE );\r
 229         __isb( portSY_FULL_READ_WRITE );\r
 230 }\r
 231 /*-----------------------------------------------------------*/\r
 232 \r
 233 #ifdef __cplusplus\r
 234 }\r
 235 #endif\r
 236 \r
 237 #endif /* PORTMACRO_H */\r
 238 \r