git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/MPLAB/PIC18F/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 #ifndef PORTMACRO_H\r
  97 #define PORTMACRO_H\r
  98 \r
  99 /*-----------------------------------------------------------\r
 100  * Port specific definitions.\r
 101  *\r
 102  * The settings in this file configure FreeRTOS correctly for the\r
 103  * given hardware and compiler.\r
 104  *\r
 105  * These settings should not be altered.\r
 106  *-----------------------------------------------------------\r
 107  */\r
 108 \r
 109 /* Type definitions. */\r
 110 #define portCHAR                char\r
 111 #define portFLOAT               float\r
 112 #define portDOUBLE              double\r
 113 #define portLONG                long\r
 114 #define portSHORT               int\r
 115 #define portSTACK_TYPE  uint8_t\r
 116 #define portBASE_TYPE   char\r
 117 \r
 118 typedef portSTACK_TYPE StackType_t;\r
 119 typedef signed char BaseType_t;\r
 120 typedef unsigned char UBaseType_t;\r
 121 \r
 122 #if( configUSE_16_BIT_TICKS == 1 )\r
 123         typedef uint16_t TickType_t;\r
 124         #define portMAX_DELAY ( TickType_t ) 0xffff\r
 125 #else\r
 126         typedef uint32_t TickType_t;\r
 127         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
 128 #endif\r
 129 /*-----------------------------------------------------------*/\r
 130 \r
 131 /* Hardware specifics. */\r
 132 #define portBYTE_ALIGNMENT                      1\r
 133 #define portGLOBAL_INT_ENABLE_BIT       0x80\r
 134 #define portSTACK_GROWTH                        1\r
 135 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 136 /*-----------------------------------------------------------*/\r
 137 \r
 138 /* Critical section management. */\r
 139 #define portDISABLE_INTERRUPTS()        INTCONbits.GIEH = 0;\r
 140 #define portENABLE_INTERRUPTS()         INTCONbits.GIEH = 1;\r
 141 \r
 142 /* Push the INTCON register onto the stack, then disable interrupts. */\r
 143 #define portENTER_CRITICAL()            POSTINC1 = INTCON;                              \\r
 144                                                                         INTCONbits.GIEH = 0;\r
 145 \r
 146 /* Retrieve the INTCON register from the stack, and enable interrupts\r
 147 if they were saved as being enabled.  Don't modify any other bits\r
 148 within the INTCON register as these may have lagitimately have been\r
 149 modified within the critical region. */\r
 150 #define portEXIT_CRITICAL()                     _asm                                                                    \\r
 151                                                                                 MOVF    POSTDEC1, 1, 0                          \\r
 152                                                                         _endasm                                                                 \\r
 153                                                                         if( INDF1 & portGLOBAL_INT_ENABLE_BIT ) \\r
 154                                                                         {                                                                               \\r
 155                                                                                 portENABLE_INTERRUPTS();                        \\r
 156                                                                         }\r
 157 /*-----------------------------------------------------------*/\r
 158 \r
 159 /* Task utilities. */\r
 160 extern void vPortYield( void );\r
 161 #define portYIELD()                             vPortYield()\r
 162 /*-----------------------------------------------------------*/\r
 163 \r
 164 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 165 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 166 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 167 /*-----------------------------------------------------------*/\r
 168 \r
 169 /* Required by the kernel aware debugger. */\r
 170 #ifdef __DEBUG\r
 171         #define portREMOVE_STATIC_QUALIFIER\r
 172 #endif\r
 173 \r
 174 \r
 175 #define portNOP()                               _asm    \\r
 176                                                                         NOP \\r
 177                                                                 _endasm\r
 178 \r
 179 #endif /* PORTMACRO_H */\r
 180 \r