git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/MPLAB/PIC18F/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 #ifndef PORTMACRO_H\r
  68 #define PORTMACRO_H\r
  69 \r
  70 /*-----------------------------------------------------------\r
  71  * Port specific definitions.  \r
  72  *\r
  73  * The settings in this file configure FreeRTOS correctly for the\r
  74  * given hardware and compiler.\r
  75  *\r
  76  * These settings should not be altered.\r
  77  *-----------------------------------------------------------\r
  78  */\r
  79 \r
  80 /* Type definitions. */\r
  81 #define portCHAR                char\r
  82 #define portFLOAT               float\r
  83 #define portDOUBLE              double\r
  84 #define portLONG                long\r
  85 #define portSHORT               int\r
  86 #define portSTACK_TYPE  unsigned char\r
  87 #define portBASE_TYPE   char\r
  88 \r
  89 #if( configUSE_16_BIT_TICKS == 1 )\r
  90         typedef unsigned portSHORT portTickType;\r
  91         #define portMAX_DELAY ( portTickType ) 0xffff\r
  92 #else\r
  93         typedef unsigned portLONG portTickType;\r
  94         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
  95 #endif\r
  96 /*-----------------------------------------------------------*/\r
  97 \r
  98 /* Hardware specifics. */\r
  99 #define portBYTE_ALIGNMENT                      1\r
 100 #define portGLOBAL_INT_ENABLE_BIT       0x80\r
 101 #define portSTACK_GROWTH                        1\r
 102 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 /* Critical section management. */\r
 106 #define portDISABLE_INTERRUPTS()        INTCONbits.GIEH = 0;\r
 107 #define portENABLE_INTERRUPTS()         INTCONbits.GIEH = 1;\r
 108 \r
 109 /* Push the INTCON register onto the stack, then disable interrupts. */\r
 110 #define portENTER_CRITICAL()            POSTINC1 = INTCON;                              \\r
 111                                                                         INTCONbits.GIEH = 0;\r
 112 \r
 113 /* Retrieve the INTCON register from the stack, and enable interrupts\r
 114 if they were saved as being enabled.  Don't modify any other bits\r
 115 within the INTCON register as these may have lagitimately have been\r
 116 modified within the critical region. */\r
 117 #define portEXIT_CRITICAL()                     _asm                                                                    \\r
 118                                                                                 MOVF    POSTDEC1, 1, 0                          \\r
 119                                                                         _endasm                                                                 \\r
 120                                                                         if( INDF1 & portGLOBAL_INT_ENABLE_BIT ) \\r
 121                                                                         {                                                                               \\r
 122                                                                                 portENABLE_INTERRUPTS();                        \\r
 123                                                                         }\r
 124 /*-----------------------------------------------------------*/\r
 125 \r
 126 /* Task utilities. */\r
 127 extern void vPortYield( void );\r
 128 #define portYIELD()                             vPortYield()\r
 129 /*-----------------------------------------------------------*/\r
 130 \r
 131 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 132 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 133 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 134 /*-----------------------------------------------------------*/\r
 135 \r
 136 /* Required by the kernel aware debugger. */\r
 137 #ifdef __DEBUG\r
 138         #define portREMOVE_STATIC_QUALIFIER\r
 139 #endif\r
 140 \r
 141 \r
 142 #define portNOP()                               _asm    \\r
 143                                                                         NOP \\r
 144                                                                 _endasm\r
 145 \r
 146 #endif /* PORTMACRO_H */\r
 147 \r