git.sur5r.net Git - freertos/blob - Source/portable/MPLAB/PIC32MX/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 /* System include files */\r
  58 #include <plib.h>\r
  59 \r
  60 #ifdef __cplusplus\r
  61 extern "C" {\r
  62 #endif\r
  63 \r
  64 /*-----------------------------------------------------------\r
  65  * Port specific definitions.  \r
  66  *\r
  67  * The settings in this file configure FreeRTOS correctly for the\r
  68  * given hardware and compiler.\r
  69  *\r
  70  * These settings should not be altered.\r
  71  *-----------------------------------------------------------\r
  72  */\r
  73 \r
  74 /* Type definitions. */\r
  75 #define portCHAR                char\r
  76 #define portFLOAT               float\r
  77 #define portDOUBLE              double\r
  78 #define portLONG                long\r
  79 #define portSHORT               short\r
  80 #define portSTACK_TYPE  unsigned long\r
  81 #define portBASE_TYPE   long\r
  82 \r
  83 #if( configUSE_16_BIT_TICKS == 1 )\r
  84         typedef unsigned portSHORT portTickType;\r
  85         #define portMAX_DELAY ( portTickType ) 0xffff\r
  86 #else\r
  87         typedef unsigned portLONG portTickType;\r
  88         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
  89 #endif\r
  90 /*-----------------------------------------------------------*/\r
  91 \r
  92 /* Hardware specifics. */\r
  93 #define portBYTE_ALIGNMENT                      8\r
  94 #define portSTACK_GROWTH                        -1\r
  95 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
  96 /*-----------------------------------------------------------*/\r
  97 \r
  98 /* Critical section management. */\r
  99 #define portIPL_SHIFT                           ( 10 )\r
 100 #define portALL_IPL_BITS                        ( 0x3f << portIPL_SHIFT )\r
 101 #define portSW0_BIT                                     ( 0x01 << 8 )\r
 102 \r
 103 #define portDISABLE_INTERRUPTS()                                                                                        \\r
 104 {                                                                                                                                                       \\r
 105 unsigned portLONG ulStatus;                                                                                                     \\r
 106                                                                                                                                                         \\r
 107         /* Mask interrupts at and below the kernel interrupt priority. */               \\r
 108         ulStatus = _CP0_GET_STATUS();                                                                                   \\r
 109         ulStatus |= ( configMAX_SYSCALL_INTERRUPT_PRIORITY << portIPL_SHIFT );  \\r
 110         _CP0_SET_STATUS( ulStatus );                                                                                    \\r
 111 }\r
 112 \r
 113 #define portENABLE_INTERRUPTS()                                                                                         \\r
 114 {                                                                                                                                                       \\r
 115 unsigned portLONG ulStatus;                                                                                                     \\r
 116                                                                                                                                                         \\r
 117         /* Unmask all interrupts. */                                                                                    \\r
 118         ulStatus = _CP0_GET_STATUS();                                                                                   \\r
 119         ulStatus &= ~portALL_IPL_BITS;                                                                                  \\r
 120         _CP0_SET_STATUS( ulStatus );                                                                                    \\r
 121 }\r
 122 \r
 123 \r
 124 extern void vTaskEnterCritical( void );\r
 125 extern void vTaskExitCritical( void );\r
 126 #define portCRITICAL_NESTING_IN_TCB     1\r
 127 #define portENTER_CRITICAL()            vTaskEnterCritical()\r
 128 #define portEXIT_CRITICAL()                     vTaskExitCritical()\r
 129 \r
 130 extern unsigned portBASE_TYPE uxPortSetInterruptMaskFromISR();\r
 131 extern void vPortClearInterruptMaskFromISR( unsigned portBASE_TYPE );\r
 132 #define portSET_INTERRUPT_MASK_FROM_ISR() uxPortSetInterruptMaskFromISR()\r
 133 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedStatusRegister ) vPortClearInterruptMaskFromISR( uxSavedStatusRegister )\r
 134 \r
 135 /*-----------------------------------------------------------*/\r
 136 \r
 137 /* Task utilities. */\r
 138 \r
 139 #define portYIELD()                                                             \\r
 140 {                                                                                               \\r
 141 unsigned portLONG ulStatus;                                             \\r
 142                                                                                                 \\r
 143         /* Trigger software interrupt. */                       \\r
 144         ulStatus = _CP0_GET_CAUSE();                            \\r
 145         ulStatus |= portSW0_BIT;                                        \\r
 146         _CP0_SET_CAUSE( ulStatus );                                     \\r
 147 }\r
 148 \r
 149 \r
 150 #define portNOP()       asm volatile (  "nop" )\r
 151 \r
 152 /*-----------------------------------------------------------*/\r
 153 \r
 154 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 155 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters ) __attribute__((noreturn))\r
 156 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 157 /*-----------------------------------------------------------*/\r
 158 \r
 159 #define portEND_SWITCHING_ISR( xSwitchRequired )        if( xSwitchRequired )   \\r
 160                                                                                                         {                                               \\r
 161                                                                                                                 portYIELD();            \\r
 162                                                                                                         }\r
 163 \r
 164 /* Required by the kernel aware debugger. */\r
 165 #ifdef __DEBUG\r
 166         #define portREMOVE_STATIC_QUALIFIER\r
 167 #endif\r
 168 \r
 169 #ifdef __cplusplus\r
 170 }\r
 171 #endif\r
 172 \r
 173 #endif /* PORTMACRO_H */\r
 174 \r