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

   1 /*\r
   2     FreeRTOS V6.0.4 - Copyright (C) 2010 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS eBook                                  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\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 exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     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     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 \r
  55 #ifndef PORTMACRO_H\r
  56 #define PORTMACRO_H\r
  57 \r
  58 #ifdef __cplusplus\r
  59 extern "C" {\r
  60 #endif\r
  61 \r
  62 /*-----------------------------------------------------------\r
  63  * Port specific definitions.  \r
  64  *\r
  65  * The settings in this file configure FreeRTOS correctly for the\r
  66  * given hardware and compiler.\r
  67  *\r
  68  * These settings should not be altered.\r
  69  *-----------------------------------------------------------\r
  70  */\r
  71 \r
  72 /* Type definitions. */\r
  73 #define portCHAR                char\r
  74 #define portFLOAT               float\r
  75 #define portDOUBLE              double\r
  76 #define portLONG                long\r
  77 #define portSHORT               short\r
  78 #define portSTACK_TYPE  unsigned portLONG\r
  79 #define portBASE_TYPE   long\r
  80 \r
  81 #if( configUSE_16_BIT_TICKS == 1 )\r
  82         typedef unsigned portSHORT portTickType;\r
  83         #define portMAX_DELAY ( portTickType ) 0xffff\r
  84 #else\r
  85         typedef unsigned portLONG portTickType;\r
  86         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
  87 #endif\r
  88 /*-----------------------------------------------------------*/ \r
  89 \r
  90 /* Architecture specifics. */\r
  91 #define portSTACK_GROWTH                        ( -1 )\r
  92 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
  93 #define portBYTE_ALIGNMENT                      8\r
  94 /*-----------------------------------------------------------*/ \r
  95 \r
  96 \r
  97 /* Scheduler utilities. */\r
  98 extern void vPortYield( void );\r
  99 extern void vPortYieldFromISR( void );\r
 100 \r
 101 #define portYIELD()                                     vPortYieldFromISR()\r
 102 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) vPortYieldFromISR()\r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 \r
 106 /* Critical section management. */\r
 107 \r
 108 extern void vPortSetInterruptMask( void );\r
 109 extern void vPortClearInterruptMask( void );\r
 110 extern void vPortEnterCritical( void );\r
 111 extern void vPortExitCritical( void );\r
 112 \r
 113 #define portDISABLE_INTERRUPTS()                                vPortSetInterruptMask()\r
 114 #define portENABLE_INTERRUPTS()                                 vPortClearInterruptMask()\r
 115 #define portENTER_CRITICAL()                                    vPortEnterCritical()\r
 116 #define portEXIT_CRITICAL()                                             vPortExitCritical()\r
 117 #define portSET_INTERRUPT_MASK_FROM_ISR()               0;vPortSetInterruptMask()\r
 118 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortClearInterruptMask();(void)x\r
 119 \r
 120 /*-----------------------------------------------------------*/\r
 121 \r
 122 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 123 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 124 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 125 \r
 126 #define portNOP()\r
 127 \r
 128 #ifdef __cplusplus\r
 129 }\r
 130 #endif\r
 131 \r
 132 #endif /* PORTMACRO_H */\r
 133 \r