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

   1 /*\r
   2     FreeRTOS V7.5.3 - Copyright (C) 2013 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     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  29     >>! the source code for proprietary components outside of the FreeRTOS\r
  30     >>! kernel.\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 #ifndef PORTMACRO_H\r
  67 #define PORTMACRO_H\r
  68 \r
  69 /*-----------------------------------------------------------\r
  70  * Port specific definitions.  \r
  71  *\r
  72  * The settings in this file configure FreeRTOS correctly for the\r
  73  * given hardware and compiler.\r
  74  *\r
  75  * These settings should not be altered.\r
  76  *-----------------------------------------------------------\r
  77  */\r
  78 \r
  79 /* Type definitions. */\r
  80 #define portCHAR                char\r
  81 #define portFLOAT               float\r
  82 #define portDOUBLE              double\r
  83 #define portLONG                long\r
  84 #define portSHORT               int\r
  85 #define portSTACK_TYPE  unsigned char\r
  86 #define portBASE_TYPE   char\r
  87 \r
  88 #if( configUSE_16_BIT_TICKS == 1 )\r
  89         typedef unsigned portSHORT portTickType;\r
  90         #define portMAX_DELAY ( portTickType ) 0xffff\r
  91 #else\r
  92         typedef unsigned portLONG portTickType;\r
  93         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
  94 #endif\r
  95 /*-----------------------------------------------------------*/\r
  96 \r
  97 /* Hardware specifics. */\r
  98 #define portBYTE_ALIGNMENT                      1\r
  99 #define portGLOBAL_INT_ENABLE_BIT       0x80\r
 100 #define portSTACK_GROWTH                        1\r
 101 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
 102 /*-----------------------------------------------------------*/\r
 103 \r
 104 /* Critical section management. */\r
 105 #define portDISABLE_INTERRUPTS()        INTCONbits.GIEH = 0;\r
 106 #define portENABLE_INTERRUPTS()         INTCONbits.GIEH = 1;\r
 107 \r
 108 /* Push the INTCON register onto the stack, then disable interrupts. */\r
 109 #define portENTER_CRITICAL()            POSTINC1 = INTCON;                              \\r
 110                                                                         INTCONbits.GIEH = 0;\r
 111 \r
 112 /* Retrieve the INTCON register from the stack, and enable interrupts\r
 113 if they were saved as being enabled.  Don't modify any other bits\r
 114 within the INTCON register as these may have lagitimately have been\r
 115 modified within the critical region. */\r
 116 #define portEXIT_CRITICAL()                     _asm                                                                    \\r
 117                                                                                 MOVF    POSTDEC1, 1, 0                          \\r
 118                                                                         _endasm                                                                 \\r
 119                                                                         if( INDF1 & portGLOBAL_INT_ENABLE_BIT ) \\r
 120                                                                         {                                                                               \\r
 121                                                                                 portENABLE_INTERRUPTS();                        \\r
 122                                                                         }\r
 123 /*-----------------------------------------------------------*/\r
 124 \r
 125 /* Task utilities. */\r
 126 extern void vPortYield( void );\r
 127 #define portYIELD()                             vPortYield()\r
 128 /*-----------------------------------------------------------*/\r
 129 \r
 130 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 131 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 132 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 133 /*-----------------------------------------------------------*/\r
 134 \r
 135 /* Required by the kernel aware debugger. */\r
 136 #ifdef __DEBUG\r
 137         #define portREMOVE_STATIC_QUALIFIER\r
 138 #endif\r
 139 \r
 140 \r
 141 #define portNOP()                               _asm    \\r
 142                                                                         NOP \\r
 143                                                                 _endasm\r
 144 \r
 145 #endif /* PORTMACRO_H */\r
 146 \r