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

   1 /*\r
   2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 #ifndef PORTMACRO_H\r
  76 #define PORTMACRO_H\r
  77 \r
  78 /* System include files */\r
  79 #include <xc.h>\r
  80 \r
  81 #ifdef __cplusplus\r
  82 extern "C" {\r
  83 #endif\r
  84 \r
  85 /*-----------------------------------------------------------\r
  86  * Port specific definitions.  \r
  87  *\r
  88  * The settings in this file configure FreeRTOS correctly for the\r
  89  * given hardware and compiler.\r
  90  *\r
  91  * These settings should not be altered.\r
  92  *-----------------------------------------------------------\r
  93  */\r
  94 \r
  95 /* Type definitions. */\r
  96 #define portCHAR                char\r
  97 #define portFLOAT               float\r
  98 #define portDOUBLE              double\r
  99 #define portLONG                long\r
 100 #define portSHORT               short\r
 101 #define portSTACK_TYPE  unsigned long\r
 102 #define portBASE_TYPE   long\r
 103 \r
 104 #if( configUSE_16_BIT_TICKS == 1 )\r
 105         typedef unsigned portSHORT portTickType;\r
 106         #define portMAX_DELAY ( portTickType ) 0xffff\r
 107 #else\r
 108         typedef unsigned long portTickType;\r
 109         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
 110 #endif\r
 111 /*-----------------------------------------------------------*/\r
 112 \r
 113 /* Hardware specifics. */\r
 114 #define portBYTE_ALIGNMENT                      8\r
 115 #define portSTACK_GROWTH                        -1\r
 116 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
 117 /*-----------------------------------------------------------*/\r
 118 \r
 119 /* Critical section management. */\r
 120 #define portIPL_SHIFT                           ( 10UL )\r
 121 #define portALL_IPL_BITS                        ( 0x3fUL << portIPL_SHIFT )\r
 122 #define portSW0_BIT                                     ( 0x01 << 8 )\r
 123 \r
 124 /* This clears the IPL bits, then sets them to \r
 125 configMAX_SYSCALL_INTERRUPT_PRIORITY.   An extra check is performed if \r
 126 configASSERT() is defined to ensure an assertion handler does not inadvertently \r
 127 attempt to lower the IPL when the call to assert was triggered because the IPL \r
 128 value was found to be above     configMAX_SYSCALL_INTERRUPT_PRIORITY when an ISR\r
 129 safe FreeRTOS API function was executed.  ISR safe FreeRTOS API functions are\r
 130 those that end in FromISR.  FreeRTOS maintains a separate interrupt API to\r
 131 ensure API function and interrupt entry is as fast and as simple as possible. */\r
 132 #ifdef configASSERT\r
 133         #define portDISABLE_INTERRUPTS()                                                                                        \\r
 134         {                                                                                                                                                       \\r
 135         unsigned long ulStatus;                                                                                                         \\r
 136                                                                                                                                                                 \\r
 137                 /* Mask interrupts at and below the kernel interrupt priority. */               \\r
 138                 ulStatus = _CP0_GET_STATUS();                                                                                   \\r
 139                                                                                                                                                                 \\r
 140                 /* Is the current IPL below configMAX_SYSCALL_INTERRUPT_PRIORITY? */    \\r
 141                 if( ( ( ulStatus & portALL_IPL_BITS ) >> portIPL_SHIFT ) < configMAX_SYSCALL_INTERRUPT_PRIORITY )       \\r
 142                 {                                                                                                                                               \\r
 143                         ulStatus &= ~portALL_IPL_BITS;                                                                          \\r
 144                         _CP0_SET_STATUS( ( ulStatus | ( configMAX_SYSCALL_INTERRUPT_PRIORITY << portIPL_SHIFT ) ) ); \\r
 145                 }                                                                                                                                               \\r
 146         }\r
 147 #else /* configASSERT */\r
 148         #define portDISABLE_INTERRUPTS()                                                                                \\r
 149         {                                                                                                                                               \\r
 150         unsigned long ulStatus;                                                                                                 \\r
 151                                                                                                                                                         \\r
 152                 /* Mask interrupts at and below the kernel interrupt priority. */       \\r
 153                 ulStatus = _CP0_GET_STATUS();                                                                           \\r
 154                 ulStatus &= ~portALL_IPL_BITS;                                                                          \\r
 155                 _CP0_SET_STATUS( ( ulStatus | ( configMAX_SYSCALL_INTERRUPT_PRIORITY << portIPL_SHIFT ) ) ); \\r
 156         }\r
 157 #endif /* configASSERT */\r
 158 \r
 159 #define portENABLE_INTERRUPTS()                                                                                 \\r
 160 {                                                                                                                                               \\r
 161 unsigned long ulStatus;                                                                                                 \\r
 162                                                                                                                                                 \\r
 163         /* Unmask all interrupts. */                                                                            \\r
 164         ulStatus = _CP0_GET_STATUS();                                                                           \\r
 165         ulStatus &= ~portALL_IPL_BITS;                                                                          \\r
 166         _CP0_SET_STATUS( ulStatus );                                                                            \\r
 167 }\r
 168 \r
 169 \r
 170 extern void vTaskEnterCritical( void );\r
 171 extern void vTaskExitCritical( void );\r
 172 #define portCRITICAL_NESTING_IN_TCB     1\r
 173 #define portENTER_CRITICAL()            vTaskEnterCritical()\r
 174 #define portEXIT_CRITICAL()                     vTaskExitCritical()\r
 175 \r
 176 extern unsigned portBASE_TYPE uxPortSetInterruptMaskFromISR();\r
 177 extern void vPortClearInterruptMaskFromISR( unsigned portBASE_TYPE );\r
 178 #define portSET_INTERRUPT_MASK_FROM_ISR() uxPortSetInterruptMaskFromISR()\r
 179 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedStatusRegister ) vPortClearInterruptMaskFromISR( uxSavedStatusRegister )\r
 180 \r
 181 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 182 \r
 183         /* Check the configuration. */\r
 184         #if( configMAX_PRIORITIES > 32 )\r
 185                 #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
 186         #endif\r
 187 \r
 188         /* Store/clear the ready priorities in a bit map. */\r
 189         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 190         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 191 \r
 192         /*-----------------------------------------------------------*/\r
 193 \r
 194         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - _clz( ( uxReadyPriorities ) ) )\r
 195 \r
 196 #endif /* taskRECORD_READY_PRIORITY */\r
 197 \r
 198 /*-----------------------------------------------------------*/\r
 199 \r
 200 /* Task utilities. */\r
 201 \r
 202 #define portYIELD()                                                             \\r
 203 {                                                                                               \\r
 204 unsigned long ulCause;                                                  \\r
 205                                                                                                 \\r
 206         /* Trigger software interrupt. */                       \\r
 207         ulCause = _CP0_GET_CAUSE();                                     \\r
 208         ulCause |= portSW0_BIT;                                         \\r
 209         _CP0_SET_CAUSE( ulCause );                                      \\r
 210 }\r
 211 \r
 212 #ifdef configASSERT\r
 213         #define portCURRENT_INTERRUPT_PRIORITY ( ( _CP0_GET_STATUS() & portALL_IPL_BITS ) >> portIPL_SHIFT )\r
 214         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() configASSERT( portCURRENT_INTERRUPT_PRIORITY <= configMAX_SYSCALL_INTERRUPT_PRIORITY )\r
 215 #endif /* configASSERT */\r
 216 \r
 217 \r
 218 #define portNOP()       asm volatile (  "nop" )\r
 219 \r
 220 /*-----------------------------------------------------------*/\r
 221 \r
 222 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 223 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters ) __attribute__((noreturn))\r
 224 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 225 /*-----------------------------------------------------------*/\r
 226 \r
 227 #define portEND_SWITCHING_ISR( xSwitchRequired )        if( xSwitchRequired )   \\r
 228                                                                                                         {                                               \\r
 229                                                                                                                 portYIELD();            \\r
 230                                                                                                         }\r
 231 \r
 232 /* Required by the kernel aware debugger. */\r
 233 #ifdef __DEBUG\r
 234         #define portREMOVE_STATIC_QUALIFIER\r
 235 #endif\r
 236 \r
 237 #ifdef __cplusplus\r
 238 }\r
 239 #endif\r
 240 \r
 241 #endif /* PORTMACRO_H */\r
 242 \r