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

   1 /*\r
   2     FreeRTOS V8.2.0rc1 - 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     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     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  14     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  15     >>!   obliged to provide the source code for proprietary components     !<<\r
  16     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  17 \r
  18     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  19     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  20     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  21     link: http://www.freertos.org/a00114.html\r
  22 \r
  23     1 tab == 4 spaces!\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  28      *    not run, what could be wrong?".  Have you defined configASSERT()?  *\r
  29      *                                                                       *\r
  30      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  31      *                                                                       *\r
  32     ***************************************************************************\r
  33 \r
  34     ***************************************************************************\r
  35      *                                                                       *\r
  36      *    FreeRTOS provides completely free yet professionally developed,    *\r
  37      *    robust, strictly quality controlled, supported, and cross          *\r
  38      *    platform software that is more than just the market leader, it     *\r
  39      *    is the industry's de facto standard.                               *\r
  40      *                                                                       *\r
  41      *    Help yourself get started quickly while simultaneously helping     *\r
  42      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  43      *    tutorial book, reference manual, or both:                          *\r
  44      *    http://www.FreeRTOS.org/Documentation                              *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     ***************************************************************************\r
  49      *                                                                       *\r
  50      *   Investing in training allows your team to be as productive as       *\r
  51      *   possible as early as possible, lowering your overall development    *\r
  52      *   cost, and enabling you to bring a more robust product to market     *\r
  53      *   earlier than would otherwise be possible.  Richard Barry is both    *\r
  54      *   the architect and key author of FreeRTOS, and so also the world's   *\r
  55      *   leading authority on what is the world's most popular real time     *\r
  56      *   kernel for deeply embedded MCU designs.  Obtaining your training    *\r
  57      *   from Richard ensures your team will gain directly from his in-depth *\r
  58      *   product knowledge and years of usage experience.  Contact Real Time *\r
  59      *   Engineers Ltd to enquire about the FreeRTOS Masterclass, presented  *\r
  60      *   by Richard Barry:  http://www.FreeRTOS.org/contact\r
  61      *                                                                       *\r
  62     ***************************************************************************\r
  63 \r
  64     ***************************************************************************\r
  65      *                                                                       *\r
  66      *    You are receiving this top quality software for free.  Please play *\r
  67      *    fair and reciprocate by reporting any suspected issues and         *\r
  68      *    participating in the community forum:                              *\r
  69      *    http://www.FreeRTOS.org/support                                    *\r
  70      *                                                                       *\r
  71      *    Thank you!                                                         *\r
  72      *                                                                       *\r
  73     ***************************************************************************\r
  74 \r
  75     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  76     license and Real Time Engineers Ltd. contact details.\r
  77 \r
  78     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  79     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  80     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  81 \r
  82     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  83     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  84 \r
  85     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  86     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  87     licenses offer ticketed support, indemnification and commercial middleware.\r
  88 \r
  89     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  90     engineered and independently SIL3 certified version for use in safety and\r
  91     mission critical applications that require provable dependability.\r
  92 \r
  93     1 tab == 4 spaces!\r
  94 */\r
  95 \r
  96 \r
  97 #ifndef PORTMACRO_H\r
  98 #define PORTMACRO_H\r
  99 \r
 100 #ifdef __cplusplus\r
 101 extern "C" {\r
 102 #endif\r
 103 \r
 104 /*-----------------------------------------------------------\r
 105  * Port specific definitions.\r
 106  *\r
 107  * The settings in this file configure FreeRTOS correctly for the\r
 108  * given hardware and compiler.\r
 109  *\r
 110  * These settings should not be altered.\r
 111  *-----------------------------------------------------------\r
 112  */\r
 113 \r
 114 /* Type definitions. */\r
 115 #define portCHAR                char\r
 116 #define portFLOAT               float\r
 117 #define portDOUBLE              double\r
 118 #define portLONG                long\r
 119 #define portSHORT               short\r
 120 #define portSTACK_TYPE  uint32_t\r
 121 #define portBASE_TYPE   long\r
 122 \r
 123 typedef portSTACK_TYPE StackType_t;\r
 124 typedef long BaseType_t;\r
 125 typedef unsigned long UBaseType_t;\r
 126 \r
 127 \r
 128 #if( configUSE_16_BIT_TICKS == 1 )\r
 129         typedef uint16_t TickType_t;\r
 130         #define portMAX_DELAY ( TickType_t ) 0xffff\r
 131 #else\r
 132         typedef uint32_t TickType_t;\r
 133         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
 134 #endif\r
 135 /*-----------------------------------------------------------*/\r
 136 \r
 137 /* Hardware specifics. */\r
 138 #define portSTACK_GROWTH                        ( -1 )\r
 139 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 140 #define portBYTE_ALIGNMENT                      8\r
 141 /*-----------------------------------------------------------*/\r
 142 \r
 143 /* Task utilities. */\r
 144 \r
 145 /*-----------------------------------------------------------\r
 146  * ISR entry and exit macros.  These are only required if a task switch\r
 147  * is required from an ISR.\r
 148  *----------------------------------------------------------*/\r
 149 \r
 150 /* If a switch is required then we just need to call */\r
 151 /* vTaskSwitchContext() as the context has already been */\r
 152 /* saved. */\r
 153 \r
 154 #define portEXIT_SWITCHING_ISR(SwitchRequired)                           \\r
 155 {                                                                                                                        \\r
 156 extern void vTaskSwitchContext(void);                                            \\r
 157                                                                                                                          \\r
 158                 if(SwitchRequired)                                                                       \\r
 159                 {                                                                                                        \\r
 160                         vTaskSwitchContext();                                                    \\r
 161                 }                                                                                                        \\r
 162 }                                                                                                                        \\r
 163 \r
 164 extern void vPortYield( void );\r
 165 #define portYIELD() vPortYield()\r
 166 \r
 167 \r
 168 /* Critical section management. */\r
 169 \r
 170 /*\r
 171  ******************************************************************\r
 172  * We don't need to worry about whether we're in ARM or\r
 173  * THUMB mode with the Keil Real View compiler when enabling\r
 174  * or disabling interrupts as the compiler's intrinsic functions\r
 175  * take care of that for us.\r
 176  *******************************************************************\r
 177  */\r
 178 #define portDISABLE_INTERRUPTS()        __disable_irq()\r
 179 #define portENABLE_INTERRUPTS()         __enable_irq()\r
 180 \r
 181 \r
 182 /*-----------------------------------------------------------\r
 183  * Critical section control\r
 184  *\r
 185  * The code generated by the Keil compiler does not maintain separate\r
 186  * stack and frame pointers. The portENTER_CRITICAL macro cannot therefore\r
 187  * use the stack as per other ports.  Instead a variable is used to keep\r
 188  * track of the critical section nesting.  This necessitates the use of a\r
 189  * function in place of the macro.\r
 190  *----------------------------------------------------------*/\r
 191 \r
 192 extern void vPortEnterCritical( void );\r
 193 extern void vPortExitCritical( void );\r
 194 \r
 195 #define portENTER_CRITICAL()            vPortEnterCritical();\r
 196 #define portEXIT_CRITICAL()                     vPortExitCritical();\r
 197 /*-----------------------------------------------------------*/\r
 198 \r
 199 /* Compiler specifics. */\r
 200 #define inline\r
 201 #define register\r
 202 #define portNOP()       __asm{ NOP }\r
 203 /*-----------------------------------------------------------*/\r
 204 \r
 205 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 206 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )      void vFunction( void *pvParameters )\r
 207 #define portTASK_FUNCTION( vFunction, pvParameters )    void vFunction( void *pvParameters )\r
 208 \r
 209 #ifdef __cplusplus\r
 210 }\r
 211 #endif\r
 212 \r
 213 #endif /* PORTMACRO_H */\r
 214 \r