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

   1 /*\r
   2     FreeRTOS V7.0.1 - Copyright (C) 2011 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     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 long 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                           ( 10UL )\r
 100 #define portALL_IPL_BITS                        ( 0x3fUL << portIPL_SHIFT )\r
 101 #define portSW0_BIT                                     ( 0x01 << 8 )\r
 102 \r
 103 /* This clears the IPL bits, then sets them to \r
 104 configMAX_SYSCALL_INTERRUPT_PRIORITY.  This function should not be called\r
 105 from an interrupt, so therefore will not be called with an IPL setting\r
 106 above configMAX_SYSCALL_INTERRUPT_PRIORITY.  Therefore, when used correctly, the \r
 107 instructions in this macro can only result in the IPL being raised, and \r
 108 therefore never lowered. */\r
 109 #define portDISABLE_INTERRUPTS()                                                                                \\r
 110 {                                                                                                                                               \\r
 111 unsigned long ulStatus;                                                                                                 \\r
 112                                                                                                                                                 \\r
 113         /* Mask interrupts at and below the kernel interrupt priority. */       \\r
 114         ulStatus = _CP0_GET_STATUS();                                                                           \\r
 115         ulStatus &= ~portALL_IPL_BITS;                                                                          \\r
 116         _CP0_SET_STATUS( ( ulStatus | ( configMAX_SYSCALL_INTERRUPT_PRIORITY << portIPL_SHIFT ) ) ); \\r
 117 }\r
 118 \r
 119 #define portENABLE_INTERRUPTS()                                                                                 \\r
 120 {                                                                                                                                               \\r
 121 unsigned long ulStatus;                                                                                                 \\r
 122                                                                                                                                                 \\r
 123         /* Unmask all interrupts. */                                                                            \\r
 124         ulStatus = _CP0_GET_STATUS();                                                                           \\r
 125         ulStatus &= ~portALL_IPL_BITS;                                                                          \\r
 126         _CP0_SET_STATUS( ulStatus );                                                                            \\r
 127 }\r
 128 \r
 129 \r
 130 extern void vTaskEnterCritical( void );\r
 131 extern void vTaskExitCritical( void );\r
 132 #define portCRITICAL_NESTING_IN_TCB     1\r
 133 #define portENTER_CRITICAL()            vTaskEnterCritical()\r
 134 #define portEXIT_CRITICAL()                     vTaskExitCritical()\r
 135 \r
 136 extern unsigned portBASE_TYPE uxPortSetInterruptMaskFromISR();\r
 137 extern void vPortClearInterruptMaskFromISR( unsigned portBASE_TYPE );\r
 138 #define portSET_INTERRUPT_MASK_FROM_ISR() uxPortSetInterruptMaskFromISR()\r
 139 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedStatusRegister ) vPortClearInterruptMaskFromISR( uxSavedStatusRegister )\r
 140 \r
 141 /*-----------------------------------------------------------*/\r
 142 \r
 143 /* Task utilities. */\r
 144 \r
 145 #define portYIELD()                                                             \\r
 146 {                                                                                               \\r
 147 unsigned long ulStatus;                                                 \\r
 148                                                                                                 \\r
 149         /* Trigger software interrupt. */                       \\r
 150         ulStatus = _CP0_GET_CAUSE();                            \\r
 151         ulStatus |= portSW0_BIT;                                        \\r
 152         _CP0_SET_CAUSE( ulStatus );                                     \\r
 153 }\r
 154 \r
 155 \r
 156 #define portNOP()       asm volatile (  "nop" )\r
 157 \r
 158 /*-----------------------------------------------------------*/\r
 159 \r
 160 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 161 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters ) __attribute__((noreturn))\r
 162 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 163 /*-----------------------------------------------------------*/\r
 164 \r
 165 #define portEND_SWITCHING_ISR( xSwitchRequired )        if( xSwitchRequired )   \\r
 166                                                                                                         {                                               \\r
 167                                                                                                                 portYIELD();            \\r
 168                                                                                                         }\r
 169 \r
 170 /* Required by the kernel aware debugger. */\r
 171 #ifdef __DEBUG\r
 172         #define portREMOVE_STATIC_QUALIFIER\r
 173 #endif\r
 174 \r
 175 #ifdef __cplusplus\r
 176 }\r
 177 #endif\r
 178 \r
 179 #endif /* PORTMACRO_H */\r
 180 \r