git.sur5r.net Git - freertos/blob - Source/portable/MPLAB/PIC18F/portmacro.h

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