git.sur5r.net Git - freertos/blob - FreeRTOS/Source/include/mpu_wrappers.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 MPU_WRAPPERS_H\r
  97 #define MPU_WRAPPERS_H\r
  98 \r
  99 /* This file redefines API functions to be called through a wrapper macro, but\r
 100 only for ports that are using the MPU. */\r
 101 #ifdef portUSING_MPU_WRAPPERS\r
 102 \r
 103         /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE will be defined when this file is\r
 104         included from queue.c or task.c to prevent it from having an effect within\r
 105         those files. */\r
 106         #ifndef MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
 107 \r
 108                 #define xTaskGenericCreate                              MPU_xTaskGenericCreate\r
 109                 #define vTaskAllocateMPURegions                 MPU_vTaskAllocateMPURegions\r
 110                 #define vTaskDelete                                             MPU_vTaskDelete\r
 111                 #define vTaskDelayUntil                                 MPU_vTaskDelayUntil\r
 112                 #define vTaskDelay                                              MPU_vTaskDelay\r
 113                 #define uxTaskPriorityGet                               MPU_uxTaskPriorityGet\r
 114                 #define vTaskPrioritySet                                MPU_vTaskPrioritySet\r
 115                 #define eTaskGetState                                   MPU_eTaskGetState\r
 116                 #define vTaskSuspend                                    MPU_vTaskSuspend\r
 117                 #define vTaskResume                                             MPU_vTaskResume\r
 118                 #define vTaskSuspendAll                                 MPU_vTaskSuspendAll\r
 119                 #define xTaskResumeAll                                  MPU_xTaskResumeAll\r
 120                 #define xTaskGetTickCount                               MPU_xTaskGetTickCount\r
 121                 #define uxTaskGetNumberOfTasks                  MPU_uxTaskGetNumberOfTasks\r
 122                 #define vTaskList                                               MPU_vTaskList\r
 123                 #define vTaskGetRunTimeStats                    MPU_vTaskGetRunTimeStats\r
 124                 #define vTaskSetApplicationTaskTag              MPU_vTaskSetApplicationTaskTag\r
 125                 #define xTaskGetApplicationTaskTag              MPU_xTaskGetApplicationTaskTag\r
 126                 #define xTaskCallApplicationTaskHook    MPU_xTaskCallApplicationTaskHook\r
 127                 #define uxTaskGetStackHighWaterMark             MPU_uxTaskGetStackHighWaterMark\r
 128                 #define xTaskGetCurrentTaskHandle               MPU_xTaskGetCurrentTaskHandle\r
 129                 #define xTaskGetSchedulerState                  MPU_xTaskGetSchedulerState\r
 130                 #define xTaskGetIdleTaskHandle                  MPU_xTaskGetIdleTaskHandle\r
 131                 #define uxTaskGetSystemState                    MPU_uxTaskGetSystemState\r
 132 \r
 133                 #define xQueueGenericCreate                             MPU_xQueueGenericCreate\r
 134                 #define xQueueCreateMutex                               MPU_xQueueCreateMutex\r
 135                 #define xQueueGiveMutexRecursive                MPU_xQueueGiveMutexRecursive\r
 136                 #define xQueueTakeMutexRecursive                MPU_xQueueTakeMutexRecursive\r
 137                 #define xQueueCreateCountingSemaphore   MPU_xQueueCreateCountingSemaphore\r
 138                 #define xQueueGenericSend                               MPU_xQueueGenericSend\r
 139                 #define xQueueAltGenericSend                    MPU_xQueueAltGenericSend\r
 140                 #define xQueueAltGenericReceive                 MPU_xQueueAltGenericReceive\r
 141                 #define xQueueGenericReceive                    MPU_xQueueGenericReceive\r
 142                 #define uxQueueMessagesWaiting                  MPU_uxQueueMessagesWaiting\r
 143                 #define vQueueDelete                                    MPU_vQueueDelete\r
 144                 #define xQueueGenericReset                              MPU_xQueueGenericReset\r
 145                 #define xQueueCreateSet                                 MPU_xQueueCreateSet\r
 146                 #define xQueueSelectFromSet                             MPU_xQueueSelectFromSet\r
 147                 #define xQueueAddToSet                                  MPU_xQueueAddToSet\r
 148                 #define xQueueRemoveFromSet                             MPU_xQueueRemoveFromSet\r
 149                 #define xQueuePeekFromISR                               MPU_xQueuePeekFromISR\r
 150                 #define xQueueGetMutexHolder                    MPU_xQueueGetMutexHolder\r
 151 \r
 152                 #define pvPortMalloc                                    MPU_pvPortMalloc\r
 153                 #define vPortFree                                               MPU_vPortFree\r
 154                 #define xPortGetFreeHeapSize                    MPU_xPortGetFreeHeapSize\r
 155                 #define vPortInitialiseBlocks                   MPU_vPortInitialiseBlocks\r
 156 \r
 157                 #if configQUEUE_REGISTRY_SIZE > 0\r
 158                         #define vQueueAddToRegistry                             MPU_vQueueAddToRegistry\r
 159                         #define vQueueUnregisterQueue                   MPU_vQueueUnregisterQueue\r
 160                 #endif\r
 161 \r
 162                 /* Remove the privileged function macro. */\r
 163                 #define PRIVILEGED_FUNCTION\r
 164 \r
 165         #else /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE */\r
 166 \r
 167                 /* Ensure API functions go in the privileged execution section. */\r
 168                 #define PRIVILEGED_FUNCTION __attribute__((section("privileged_functions")))\r
 169                 #define PRIVILEGED_DATA __attribute__((section("privileged_data")))\r
 170 \r
 171         #endif /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE */\r
 172 \r
 173 #else /* portUSING_MPU_WRAPPERS */\r
 174 \r
 175         #define PRIVILEGED_FUNCTION\r
 176         #define PRIVILEGED_DATA\r
 177         #define portUSING_MPU_WRAPPERS 0\r
 178 \r
 179 #endif /* portUSING_MPU_WRAPPERS */\r
 180 \r
 181 \r
 182 #endif /* MPU_WRAPPERS_H */\r
 183 \r