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

   1 /*\r
   2     FreeRTOS V7.2.0 - Copyright (C) 2012 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     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 #ifndef PORTMACRO_H\r
  68 #define PORTMACRO_H\r
  69 \r
  70 /* System include files */\r
  71 #include <plib.h>\r
  72 \r
  73 #ifdef __cplusplus\r
  74 extern "C" {\r
  75 #endif\r
  76 \r
  77 /*-----------------------------------------------------------\r
  78  * Port specific definitions.  \r
  79  *\r
  80  * The settings in this file configure FreeRTOS correctly for the\r
  81  * given hardware and compiler.\r
  82  *\r
  83  * These settings should not be altered.\r
  84  *-----------------------------------------------------------\r
  85  */\r
  86 \r
  87 /* Type definitions. */\r
  88 #define portCHAR                char\r
  89 #define portFLOAT               float\r
  90 #define portDOUBLE              double\r
  91 #define portLONG                long\r
  92 #define portSHORT               short\r
  93 #define portSTACK_TYPE  unsigned long\r
  94 #define portBASE_TYPE   long\r
  95 \r
  96 #if( configUSE_16_BIT_TICKS == 1 )\r
  97         typedef unsigned portSHORT portTickType;\r
  98         #define portMAX_DELAY ( portTickType ) 0xffff\r
  99 #else\r
 100         typedef unsigned long portTickType;\r
 101         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
 102 #endif\r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 /* Hardware specifics. */\r
 106 #define portBYTE_ALIGNMENT                      8\r
 107 #define portSTACK_GROWTH                        -1\r
 108 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
 109 /*-----------------------------------------------------------*/\r
 110 \r
 111 /* Critical section management. */\r
 112 #define portIPL_SHIFT                           ( 10UL )\r
 113 #define portALL_IPL_BITS                        ( 0x3fUL << portIPL_SHIFT )\r
 114 #define portSW0_BIT                                     ( 0x01 << 8 )\r
 115 \r
 116 /* This clears the IPL bits, then sets them to \r
 117 configMAX_SYSCALL_INTERRUPT_PRIORITY.  This function should not be called\r
 118 from an interrupt, so therefore will not be called with an IPL setting\r
 119 above configMAX_SYSCALL_INTERRUPT_PRIORITY.  Therefore, when used correctly, the \r
 120 instructions in this macro can only result in the IPL being raised, and \r
 121 therefore never lowered. */\r
 122 #define portDISABLE_INTERRUPTS()                                                                                \\r
 123 {                                                                                                                                               \\r
 124 unsigned long ulStatus;                                                                                                 \\r
 125                                                                                                                                                 \\r
 126         /* Mask interrupts at and below the kernel interrupt priority. */       \\r
 127         ulStatus = _CP0_GET_STATUS();                                                                           \\r
 128         ulStatus &= ~portALL_IPL_BITS;                                                                          \\r
 129         _CP0_SET_STATUS( ( ulStatus | ( configMAX_SYSCALL_INTERRUPT_PRIORITY << portIPL_SHIFT ) ) ); \\r
 130 }\r
 131 \r
 132 #define portENABLE_INTERRUPTS()                                                                                 \\r
 133 {                                                                                                                                               \\r
 134 unsigned long ulStatus;                                                                                                 \\r
 135                                                                                                                                                 \\r
 136         /* Unmask all interrupts. */                                                                            \\r
 137         ulStatus = _CP0_GET_STATUS();                                                                           \\r
 138         ulStatus &= ~portALL_IPL_BITS;                                                                          \\r
 139         _CP0_SET_STATUS( ulStatus );                                                                            \\r
 140 }\r
 141 \r
 142 \r
 143 extern void vTaskEnterCritical( void );\r
 144 extern void vTaskExitCritical( void );\r
 145 #define portCRITICAL_NESTING_IN_TCB     1\r
 146 #define portENTER_CRITICAL()            vTaskEnterCritical()\r
 147 #define portEXIT_CRITICAL()                     vTaskExitCritical()\r
 148 \r
 149 extern unsigned portBASE_TYPE uxPortSetInterruptMaskFromISR();\r
 150 extern void vPortClearInterruptMaskFromISR( unsigned portBASE_TYPE );\r
 151 #define portSET_INTERRUPT_MASK_FROM_ISR() uxPortSetInterruptMaskFromISR()\r
 152 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedStatusRegister ) vPortClearInterruptMaskFromISR( uxSavedStatusRegister )\r
 153 \r
 154 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 155 \r
 156         /* Check the configuration. */\r
 157         #if( configMAX_PRIORITIES > 32 )\r
 158                 #error configUSE_PORT_OPTIMISED_TASK_SELECTION can only be set to 1 when configMAX_PRIORITIES is less than or equal to 32.  It is very rare that a system requires more than 10 to 15 difference priorities as tasks that share a priority will time slice.\r
 159         #endif\r
 160 \r
 161         /* Store/clear the ready priorities in a bit map. */\r
 162         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 163         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 164 \r
 165         /*-----------------------------------------------------------*/\r
 166 \r
 167         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - _clz( ( uxReadyPriorities ) ) )\r
 168 \r
 169 #endif /* taskRECORD_READY_PRIORITY */\r
 170 \r
 171 /*-----------------------------------------------------------*/\r
 172 \r
 173 /* Task utilities. */\r
 174 \r
 175 #define portYIELD()                                                             \\r
 176 {                                                                                               \\r
 177 unsigned long ulStatus;                                                 \\r
 178                                                                                                 \\r
 179         /* Trigger software interrupt. */                       \\r
 180         ulStatus = _CP0_GET_CAUSE();                            \\r
 181         ulStatus |= portSW0_BIT;                                        \\r
 182         _CP0_SET_CAUSE( ulStatus );                                     \\r
 183 }\r
 184 \r
 185 \r
 186 #define portNOP()       asm volatile (  "nop" )\r
 187 \r
 188 /*-----------------------------------------------------------*/\r
 189 \r
 190 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 191 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters ) __attribute__((noreturn))\r
 192 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 193 /*-----------------------------------------------------------*/\r
 194 \r
 195 #define portEND_SWITCHING_ISR( xSwitchRequired )        if( xSwitchRequired )   \\r
 196                                                                                                         {                                               \\r
 197                                                                                                                 portYIELD();            \\r
 198                                                                                                         }\r
 199 \r
 200 /* Required by the kernel aware debugger. */\r
 201 #ifdef __DEBUG\r
 202         #define portREMOVE_STATIC_QUALIFIER\r
 203 #endif\r
 204 \r
 205 #ifdef __cplusplus\r
 206 }\r
 207 #endif\r
 208 \r
 209 #endif /* PORTMACRO_H */\r
 210 \r