git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/GCC/ARM_CM3/portmacro.h

   1 /*\r
   2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 \r
  76 #ifndef PORTMACRO_H\r
  77 #define PORTMACRO_H\r
  78 \r
  79 #ifdef __cplusplus\r
  80 extern "C" {\r
  81 #endif\r
  82 \r
  83 /*-----------------------------------------------------------\r
  84  * Port specific definitions.\r
  85  *\r
  86  * The settings in this file configure FreeRTOS correctly for the\r
  87  * given hardware and compiler.\r
  88  *\r
  89  * These settings should not be altered.\r
  90  *-----------------------------------------------------------\r
  91  */\r
  92 \r
  93 /* Type definitions. */\r
  94 #define portCHAR                char\r
  95 #define portFLOAT               float\r
  96 #define portDOUBLE              double\r
  97 #define portLONG                long\r
  98 #define portSHORT               short\r
  99 #define portSTACK_TYPE  unsigned portLONG\r
 100 #define portBASE_TYPE   long\r
 101 \r
 102 #if( configUSE_16_BIT_TICKS == 1 )\r
 103         typedef unsigned portSHORT portTickType;\r
 104         #define portMAX_DELAY ( portTickType ) 0xffff\r
 105 #else\r
 106         typedef unsigned portLONG portTickType;\r
 107         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
 108 #endif\r
 109 /*-----------------------------------------------------------*/\r
 110 \r
 111 /* Architecture specifics. */\r
 112 #define portSTACK_GROWTH                        ( -1 )\r
 113 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )\r
 114 #define portBYTE_ALIGNMENT                      8\r
 115 /*-----------------------------------------------------------*/\r
 116 \r
 117 \r
 118 /* Scheduler utilities. */\r
 119 extern void vPortYield( void );\r
 120 #define portNVIC_INT_CTRL_REG           ( * ( ( volatile unsigned long * ) 0xe000ed04 ) )\r
 121 #define portNVIC_PENDSVSET_BIT          ( 1UL << 28UL )\r
 122 #define portYIELD()                                     vPortYield()\r
 123 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT\r
 124 /*-----------------------------------------------------------*/\r
 125 \r
 126 /* Critical section management. */\r
 127 extern void vPortEnterCritical( void );\r
 128 extern void vPortExitCritical( void );\r
 129 extern unsigned long ulPortSetInterruptMask( void );\r
 130 extern void vPortClearInterruptMask( unsigned long ulNewMaskValue );\r
 131 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortSetInterruptMask()\r
 132 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortClearInterruptMask(x)\r
 133 #define portDISABLE_INTERRUPTS()                                ulPortSetInterruptMask()\r
 134 #define portENABLE_INTERRUPTS()                                 vPortClearInterruptMask(0)\r
 135 #define portENTER_CRITICAL()                                    vPortEnterCritical()\r
 136 #define portEXIT_CRITICAL()                                             vPortExitCritical()\r
 137 /*-----------------------------------------------------------*/\r
 138 \r
 139 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 140 not necessary for to use this port.  They are defined so the common demo files\r
 141 (which build with all the ports) will build. */\r
 142 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 143 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 144 /*-----------------------------------------------------------*/\r
 145 \r
 146 /* Tickless idle/low power functionality. */\r
 147 #ifndef portSUPPRESS_TICKS_AND_SLEEP\r
 148         extern void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime );\r
 149         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )\r
 150 #endif\r
 151 /*-----------------------------------------------------------*/\r
 152 \r
 153 /* Architecture specific optimisations. */\r
 154 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 155 \r
 156         /* Generic helper function. */\r
 157         __attribute__( ( always_inline ) ) static inline unsigned char ucPortCountLeadingZeros( unsigned long ulBitmap )\r
 158         {\r
 159         unsigned char ucReturn;\r
 160 \r
 161                 __asm volatile ( "clz %0, %1" : "=r" ( ucReturn ) : "r" ( ulBitmap ) );\r
 162                 return ucReturn;\r
 163         }\r
 164 \r
 165         /* Check the configuration. */\r
 166         #if( configMAX_PRIORITIES > 32 )\r
 167                 #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
 168         #endif\r
 169 \r
 170         /* Store/clear the ready priorities in a bit map. */\r
 171         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 172         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 173 \r
 174         /*-----------------------------------------------------------*/\r
 175 \r
 176         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - ucPortCountLeadingZeros( ( uxReadyPriorities ) ) )\r
 177 \r
 178 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 179 \r
 180 /*-----------------------------------------------------------*/\r
 181 \r
 182 /* portNOP() is not required by this port. */\r
 183 #define portNOP()\r
 184 \r
 185 #ifdef __cplusplus\r
 186 }\r
 187 #endif\r
 188 \r
 189 #endif /* PORTMACRO_H */\r
 190 \r