]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/include/portable.h
Replace standard types with stdint.h types.
[freertos] / FreeRTOS / Source / include / portable.h
index 38882d3998706913b616ada7f71b238382aa84f6..b28ecfdfe2c5c56d26874af9b2b8b12e3f470b71 100644 (file)
@@ -1,67 +1,66 @@
 /*\r
-    FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.\r
+    FreeRTOS V7.6.0 - Copyright (C) 2013 Real Time Engineers Ltd.\r
+    All rights reserved\r
 \r
+    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
 \r
     ***************************************************************************\r
      *                                                                       *\r
-     *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
-     *    Complete, revised, and edited pdf reference manuals are also       *\r
-     *    available.                                                         *\r
+     *    FreeRTOS provides completely free yet professionally developed,    *\r
+     *    robust, strictly quality controlled, supported, and cross          *\r
+     *    platform software that has become a de facto standard.             *\r
      *                                                                       *\r
-     *    Purchasing FreeRTOS documentation will not only help you, by       *\r
-     *    ensuring you get running as quickly as possible and with an        *\r
-     *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
-     *    the FreeRTOS project to continue with its mission of providing     *\r
-     *    professional grade, cross platform, de facto standard solutions    *\r
-     *    for microcontrollers - completely free of charge!                  *\r
+     *    Help yourself get started quickly and support the FreeRTOS         *\r
+     *    project by purchasing a FreeRTOS tutorial book, reference          *\r
+     *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
      *                                                                       *\r
-     *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
-     *                                                                       *\r
-     *    Thank you for using FreeRTOS, and thank you for your support!      *\r
+     *    Thank you!                                                         *\r
      *                                                                       *\r
     ***************************************************************************\r
 \r
-\r
     This file is part of the FreeRTOS distribution.\r
 \r
     FreeRTOS is free software; you can redistribute it and/or modify it under\r
     the terms of the GNU General Public License (version 2) as published by the\r
-    Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
-    >>>NOTE<<< The modification to the GPL is included to allow you to\r
-    distribute a combined work that includes FreeRTOS without being obliged to\r
-    provide the source code for proprietary components outside of the FreeRTOS\r
-    kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
-    WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
-    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
-    more details. You should have received a copy of the GNU General Public\r
-    License and the FreeRTOS license exception along with FreeRTOS; if not it\r
-    can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
-    by writing to Richard Barry, contact details for whom are available on the\r
-    FreeRTOS WEB site.\r
+    Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
+\r
+    >>! NOTE: The modification to the GPL is included to allow you to distribute\r
+    >>! a combined work that includes FreeRTOS without being obliged to provide\r
+    >>! the source code for proprietary components outside of the FreeRTOS\r
+    >>! kernel.\r
+\r
+    FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
+    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
+    FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
+    link: http://www.freertos.org/a00114.html\r
 \r
     1 tab == 4 spaces!\r
-    \r
+\r
     ***************************************************************************\r
      *                                                                       *\r
      *    Having a problem?  Start by reading the FAQ "My application does   *\r
-     *    not run, what could be wrong?                                      *\r
+     *    not run, what could be wrong?"                                     *\r
      *                                                                       *\r
      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
      *                                                                       *\r
     ***************************************************************************\r
 \r
-    \r
-    http://www.FreeRTOS.org - Documentation, training, latest information, \r
-    license and contact details.\r
-    \r
+    http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
+    license and Real Time Engineers Ltd. contact details.\r
+\r
     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
-    including FreeRTOS+Trace - an indispensable productivity tool.\r
+    including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
+    compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
+\r
+    http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
+    Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
+    licenses offer ticketed support, indemnification and middleware.\r
+\r
+    http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
+    engineered and independently SIL3 certified version for use in safety and\r
+    mission critical applications that require provable dependability.\r
 \r
-    Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
-    the code with commercial support, indemnification, and middleware, under \r
-    the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
-    provide a safety engineered and independently SIL3 certified version under \r
-    the SafeRTOS brand: http://www.SafeRTOS.com.\r
+    1 tab == 4 spaces!\r
 */\r
 \r
 /*-----------------------------------------------------------\r
 #ifndef PORTABLE_H\r
 #define PORTABLE_H\r
 \r
-/* Include the macro file relevant to the port being used. */\r
-\r
+/* Include the macro file relevant to the port being used.\r
+NOTE:  The following definitions are *DEPRECATED* as it is preferred to instead\r
+just add the path to the correct portmacro.h header file to the compiler's\r
+include path. */\r
 #ifdef OPEN_WATCOM_INDUSTRIAL_PC_PORT\r
        #include "..\..\Source\portable\owatcom\16bitdos\pc\portmacro.h"\r
        typedef void ( __interrupt __far *pxISR )();\r
 #endif\r
 \r
 #ifdef MPLAB_PIC24_PORT\r
-       #include "..\..\Source\portable\MPLAB\PIC24_dsPIC\portmacro.h"\r
+       #include "../../Source/portable/MPLAB/PIC24_dsPIC/portmacro.h"\r
 #endif\r
 \r
 #ifdef MPLAB_DSPIC_PORT\r
-       #include "..\..\Source\portable\MPLAB\PIC24_dsPIC\portmacro.h"\r
+       #include "../../Source/portable/MPLAB/PIC24_dsPIC/portmacro.h"\r
 #endif\r
 \r
 #ifdef MPLAB_PIC18F_PORT\r
-       #include "..\..\Source\portable\MPLAB\PIC18F\portmacro.h"\r
+       #include "../../Source/portable/MPLAB/PIC18F/portmacro.h"\r
 #endif\r
 \r
 #ifdef MPLAB_PIC32MX_PORT\r
-       #include "..\..\Source\portable\MPLAB\PIC32MX\portmacro.h"\r
+       #include "../../Source/portable/MPLAB/PIC32MX/portmacro.h"\r
 #endif\r
 \r
 #ifdef _FEDPICC\r
 #endif\r
 \r
 #ifdef IAR_MSP430\r
-       #include "..\..\Source\portable\IAR\MSP430\portmacro.h" \r
+       #include "..\..\Source\portable\IAR\MSP430\portmacro.h"\r
 #endif\r
-       \r
+\r
 #ifdef GCC_MSP430\r
        #include "../../Source/portable/GCC/MSP430F449/portmacro.h"\r
 #endif\r
 #ifdef STR75X_IAR\r
        #include "..\..\Source\portable\IAR\STR75x\portmacro.h"\r
 #endif\r
-       \r
+\r
 #ifdef STR75X_GCC\r
        #include "..\..\Source\portable\GCC\STR75x\portmacro.h"\r
 #endif\r
 #ifdef STR91X_IAR\r
        #include "..\..\Source\portable\IAR\STR91x\portmacro.h"\r
 #endif\r
-       \r
+\r
 #ifdef GCC_H8S\r
        #include "../../Source/portable/GCC/H8S2329/portmacro.h"\r
 #endif\r
 #ifdef IAR_ARMCM3_LM\r
        #include "../../Source/portable/IAR/ARM_CM3/portmacro.h"\r
 #endif\r
-       \r
+\r
 #ifdef HCS12_CODE_WARRIOR\r
        #include "../../Source/portable/CodeWarrior/HCS12/portmacro.h"\r
-#endif \r
+#endif\r
 \r
 #ifdef MICROBLAZE_GCC\r
        #include "../../Source/portable/GCC/MicroBlaze/portmacro.h"\r
 #ifdef __IAR_78K0R_Kx3__\r
        #include "../../Source/portable/IAR/78K0R/portmacro.h"\r
 #endif\r
-       \r
+\r
 #ifdef __IAR_78K0R_Kx3L__\r
        #include "../../Source/portable/IAR/78K0R/portmacro.h"\r
 #endif\r
-       \r
+\r
 /* Catch all to ensure portmacro.h is included in the build.  Newer demos\r
 have the path as part of the project options, rather than as relative from\r
 the project location.  If portENTER_CRITICAL() has not been defined then\r
@@ -317,9 +318,9 @@ portmacro.h has not yet been included - as every portmacro.h provides a
 portENTER_CRITICAL() definition.  Check the demo application for your demo\r
 to find the path to the correct portmacro.h file. */\r
 #ifndef portENTER_CRITICAL\r
-       #include "portmacro.h"  \r
+       #include "portmacro.h"\r
 #endif\r
-       \r
+\r
 #if portBYTE_ALIGNMENT == 8\r
        #define portBYTE_ALIGNMENT_MASK ( 0x0007 )\r
 #endif\r
@@ -357,9 +358,9 @@ extern "C" {
  *\r
  */\r
 #if( portUSING_MPU_WRAPPERS == 1 )\r
-       portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters, portBASE_TYPE xRunPrivileged ) PRIVILEGED_FUNCTION;\r
+       StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters, BaseType_t xRunPrivileged ) PRIVILEGED_FUNCTION;\r
 #else\r
-       portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters );\r
+       StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters ) PRIVILEGED_FUNCTION;\r
 #endif\r
 \r
 /*\r
@@ -369,12 +370,13 @@ void *pvPortMalloc( size_t xSize ) PRIVILEGED_FUNCTION;
 void vPortFree( void *pv ) PRIVILEGED_FUNCTION;\r
 void vPortInitialiseBlocks( void ) PRIVILEGED_FUNCTION;\r
 size_t xPortGetFreeHeapSize( void ) PRIVILEGED_FUNCTION;\r
+size_t xPortGetMinimumEverFreeHeapSize( void ) PRIVILEGED_FUNCTION;\r
 \r
 /*\r
  * Setup the hardware ready for the scheduler to take control.  This generally\r
  * sets up a tick interrupt and sets timers for the correct tick frequency.\r
  */\r
-portBASE_TYPE xPortStartScheduler( void ) PRIVILEGED_FUNCTION;\r
+BaseType_t xPortStartScheduler( void ) PRIVILEGED_FUNCTION;\r
 \r
 /*\r
  * Undo any hardware/ISR setup that was performed by xPortStartScheduler() so\r
@@ -390,9 +392,9 @@ void vPortEndScheduler( void ) PRIVILEGED_FUNCTION;
  * Fills the xMPUSettings structure with the memory region information\r
  * contained in xRegions.\r
  */\r
-#if( portUSING_MPU_WRAPPERS == 1 ) \r
+#if( portUSING_MPU_WRAPPERS == 1 )\r
        struct xMEMORY_REGION;\r
-       void vPortStoreTaskMPUSettings( xMPU_SETTINGS *xMPUSettings, const struct xMEMORY_REGION * const xRegions, portSTACK_TYPE *pxBottomOfStack, unsigned short usStackDepth ) PRIVILEGED_FUNCTION;\r
+       void vPortStoreTaskMPUSettings( xMPU_SETTINGS *xMPUSettings, const struct xMEMORY_REGION * const xRegions, StackType_t *pxBottomOfStack, uint16_t usStackDepth ) PRIVILEGED_FUNCTION;\r
 #endif\r
 \r
 #ifdef __cplusplus\r