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

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