begriffs open source - freertos/blob - include/mpu_wrappers.h

   1 /*\r
   2  * FreeRTOS Kernel V10.3.1\r
   3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  */\r
  26 \r
  27 #ifndef MPU_WRAPPERS_H\r
  28 #define MPU_WRAPPERS_H\r
  29 \r
  30 /* This file redefines API functions to be called through a wrapper macro, but\r
  31  * only for ports that are using the MPU. */\r
  32 #ifdef portUSING_MPU_WRAPPERS\r
  33 \r
  34 /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE will be defined when this file is\r
  35  * included from queue.c or task.c to prevent it from having an effect within\r
  36  * those files. */\r
  37     #ifndef MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
  38 \r
  39 /*\r
  40  * Map standard (non MPU) API functions to equivalents that start\r
  41  * "MPU_".  This will cause the application code to call the MPU_\r
  42  * version, which wraps the non-MPU version with privilege promoting\r
  43  * then demoting code, so the kernel code always runs will full\r
  44  * privileges.\r
  45  */\r
  46 \r
  47 /* Map standard tasks.h API functions to the MPU equivalents. */\r
  48         #define xTaskCreate                            MPU_xTaskCreate\r
  49         #define xTaskCreateStatic                      MPU_xTaskCreateStatic\r
  50         #define xTaskCreateRestricted                  MPU_xTaskCreateRestricted\r
  51         #define vTaskAllocateMPURegions                MPU_vTaskAllocateMPURegions\r
  52         #define vTaskDelete                            MPU_vTaskDelete\r
  53         #define vTaskDelay                             MPU_vTaskDelay\r
  54         #define vTaskDelayUntil                        MPU_vTaskDelayUntil\r
  55         #define xTaskAbortDelay                        MPU_xTaskAbortDelay\r
  56         #define uxTaskPriorityGet                      MPU_uxTaskPriorityGet\r
  57         #define eTaskGetState                          MPU_eTaskGetState\r
  58         #define vTaskGetInfo                           MPU_vTaskGetInfo\r
  59         #define vTaskPrioritySet                       MPU_vTaskPrioritySet\r
  60         #define vTaskSuspend                           MPU_vTaskSuspend\r
  61         #define vTaskResume                            MPU_vTaskResume\r
  62         #define vTaskSuspendAll                        MPU_vTaskSuspendAll\r
  63         #define xTaskResumeAll                         MPU_xTaskResumeAll\r
  64         #define xTaskGetTickCount                      MPU_xTaskGetTickCount\r
  65         #define uxTaskGetNumberOfTasks                 MPU_uxTaskGetNumberOfTasks\r
  66         #define pcTaskGetName                          MPU_pcTaskGetName\r
  67         #define xTaskGetHandle                         MPU_xTaskGetHandle\r
  68         #define uxTaskGetStackHighWaterMark            MPU_uxTaskGetStackHighWaterMark\r
  69         #define uxTaskGetStackHighWaterMark2           MPU_uxTaskGetStackHighWaterMark2\r
  70         #define vTaskSetApplicationTaskTag             MPU_vTaskSetApplicationTaskTag\r
  71         #define xTaskGetApplicationTaskTag             MPU_xTaskGetApplicationTaskTag\r
  72         #define vTaskSetThreadLocalStoragePointer      MPU_vTaskSetThreadLocalStoragePointer\r
  73         #define pvTaskGetThreadLocalStoragePointer     MPU_pvTaskGetThreadLocalStoragePointer\r
  74         #define xTaskCallApplicationTaskHook           MPU_xTaskCallApplicationTaskHook\r
  75         #define xTaskGetIdleTaskHandle                 MPU_xTaskGetIdleTaskHandle\r
  76         #define uxTaskGetSystemState                   MPU_uxTaskGetSystemState\r
  77         #define vTaskList                              MPU_vTaskList\r
  78         #define vTaskGetRunTimeStats                   MPU_vTaskGetRunTimeStats\r
  79         #define ulTaskGetIdleRunTimeCounter            MPU_ulTaskGetIdleRunTimeCounter\r
  80         #define xTaskGenericNotify                     MPU_xTaskGenericNotify\r
  81         #define xTaskGenericNotifyWait                 MPU_xTaskGenericNotifyWait\r
  82         #define ulTaskGenericNotifyTake                MPU_ulTaskGenericNotifyTake\r
  83         #define xTaskGenericNotifyStateClear           MPU_xTaskGenericNotifyStateClear\r
  84         #define ulTaskGenericNotifyValueClear          MPU_ulTaskGenericNotifyValueClear\r
  85         #define xTaskCatchUpTicks                      MPU_xTaskCatchUpTicks\r
  86 \r
  87         #define xTaskGetCurrentTaskHandle              MPU_xTaskGetCurrentTaskHandle\r
  88         #define vTaskSetTimeOutState                   MPU_vTaskSetTimeOutState\r
  89         #define xTaskCheckForTimeOut                   MPU_xTaskCheckForTimeOut\r
  90         #define xTaskGetSchedulerState                 MPU_xTaskGetSchedulerState\r
  91 \r
  92 /* Map standard queue.h API functions to the MPU equivalents. */\r
  93         #define xQueueGenericSend                      MPU_xQueueGenericSend\r
  94         #define xQueueReceive                          MPU_xQueueReceive\r
  95         #define xQueuePeek                             MPU_xQueuePeek\r
  96         #define xQueueSemaphoreTake                    MPU_xQueueSemaphoreTake\r
  97         #define uxQueueMessagesWaiting                 MPU_uxQueueMessagesWaiting\r
  98         #define uxQueueSpacesAvailable                 MPU_uxQueueSpacesAvailable\r
  99         #define vQueueDelete                           MPU_vQueueDelete\r
 100         #define xQueueCreateMutex                      MPU_xQueueCreateMutex\r
 101         #define xQueueCreateMutexStatic                MPU_xQueueCreateMutexStatic\r
 102         #define xQueueCreateCountingSemaphore          MPU_xQueueCreateCountingSemaphore\r
 103         #define xQueueCreateCountingSemaphoreStatic    MPU_xQueueCreateCountingSemaphoreStatic\r
 104         #define xQueueGetMutexHolder                   MPU_xQueueGetMutexHolder\r
 105         #define xQueueTakeMutexRecursive               MPU_xQueueTakeMutexRecursive\r
 106         #define xQueueGiveMutexRecursive               MPU_xQueueGiveMutexRecursive\r
 107         #define xQueueGenericCreate                    MPU_xQueueGenericCreate\r
 108         #define xQueueGenericCreateStatic              MPU_xQueueGenericCreateStatic\r
 109         #define xQueueCreateSet                        MPU_xQueueCreateSet\r
 110         #define xQueueAddToSet                         MPU_xQueueAddToSet\r
 111         #define xQueueRemoveFromSet                    MPU_xQueueRemoveFromSet\r
 112         #define xQueueSelectFromSet                    MPU_xQueueSelectFromSet\r
 113         #define xQueueGenericReset                     MPU_xQueueGenericReset\r
 114 \r
 115         #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
 116             #define vQueueAddToRegistry                MPU_vQueueAddToRegistry\r
 117             #define vQueueUnregisterQueue              MPU_vQueueUnregisterQueue\r
 118             #define pcQueueGetName                     MPU_pcQueueGetName\r
 119         #endif\r
 120 \r
 121 /* Map standard timer.h API functions to the MPU equivalents. */\r
 122         #define xTimerCreate                           MPU_xTimerCreate\r
 123         #define xTimerCreateStatic                     MPU_xTimerCreateStatic\r
 124         #define pvTimerGetTimerID                      MPU_pvTimerGetTimerID\r
 125         #define vTimerSetTimerID                       MPU_vTimerSetTimerID\r
 126         #define xTimerIsTimerActive                    MPU_xTimerIsTimerActive\r
 127         #define xTimerGetTimerDaemonTaskHandle         MPU_xTimerGetTimerDaemonTaskHandle\r
 128         #define xTimerPendFunctionCall                 MPU_xTimerPendFunctionCall\r
 129         #define pcTimerGetName                         MPU_pcTimerGetName\r
 130         #define vTimerSetReloadMode                    MPU_vTimerSetReloadMode\r
 131         #define uxTimerGetReloadMode                   MPU_uxTimerGetReloadMode\r
 132         #define xTimerGetPeriod                        MPU_xTimerGetPeriod\r
 133         #define xTimerGetExpiryTime                    MPU_xTimerGetExpiryTime\r
 134         #define xTimerGenericCommand                   MPU_xTimerGenericCommand\r
 135 \r
 136 /* Map standard event_group.h API functions to the MPU equivalents. */\r
 137         #define xEventGroupCreate                      MPU_xEventGroupCreate\r
 138         #define xEventGroupCreateStatic                MPU_xEventGroupCreateStatic\r
 139         #define xEventGroupWaitBits                    MPU_xEventGroupWaitBits\r
 140         #define xEventGroupClearBits                   MPU_xEventGroupClearBits\r
 141         #define xEventGroupSetBits                     MPU_xEventGroupSetBits\r
 142         #define xEventGroupSync                        MPU_xEventGroupSync\r
 143         #define vEventGroupDelete                      MPU_vEventGroupDelete\r
 144 \r
 145 /* Map standard message/stream_buffer.h API functions to the MPU\r
 146  * equivalents. */\r
 147         #define xStreamBufferSend                      MPU_xStreamBufferSend\r
 148         #define xStreamBufferReceive                   MPU_xStreamBufferReceive\r
 149         #define xStreamBufferNextMessageLengthBytes    MPU_xStreamBufferNextMessageLengthBytes\r
 150         #define vStreamBufferDelete                    MPU_vStreamBufferDelete\r
 151         #define xStreamBufferIsFull                    MPU_xStreamBufferIsFull\r
 152         #define xStreamBufferIsEmpty                   MPU_xStreamBufferIsEmpty\r
 153         #define xStreamBufferReset                     MPU_xStreamBufferReset\r
 154         #define xStreamBufferSpacesAvailable           MPU_xStreamBufferSpacesAvailable\r
 155         #define xStreamBufferBytesAvailable            MPU_xStreamBufferBytesAvailable\r
 156         #define xStreamBufferSetTriggerLevel           MPU_xStreamBufferSetTriggerLevel\r
 157         #define xStreamBufferGenericCreate             MPU_xStreamBufferGenericCreate\r
 158         #define xStreamBufferGenericCreateStatic       MPU_xStreamBufferGenericCreateStatic\r
 159 \r
 160 \r
 161 /* Remove the privileged function macro, but keep the PRIVILEGED_DATA\r
 162  * macro so applications can place data in privileged access sections\r
 163  * (useful when using statically allocated objects). */\r
 164         #define PRIVILEGED_FUNCTION\r
 165         #define PRIVILEGED_DATA    __attribute__( ( section( "privileged_data" ) ) )\r
 166         #define FREERTOS_SYSTEM_CALL\r
 167 \r
 168     #else /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE */\r
 169 \r
 170 /* Ensure API functions go in the privileged execution section. */\r
 171         #define PRIVILEGED_FUNCTION     __attribute__( ( section( "privileged_functions" ) ) )\r
 172         #define PRIVILEGED_DATA         __attribute__( ( section( "privileged_data" ) ) )\r
 173         #define FREERTOS_SYSTEM_CALL    __attribute__( ( section( "freertos_system_calls" ) ) )\r
 174 \r
 175     #endif /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE */\r
 176 \r
 177 #else /* portUSING_MPU_WRAPPERS */\r
 178 \r
 179     #define PRIVILEGED_FUNCTION\r
 180     #define PRIVILEGED_DATA\r
 181     #define FREERTOS_SYSTEM_CALL\r
 182     #define portUSING_MPU_WRAPPERS    0\r
 183 \r
 184 #endif /* portUSING_MPU_WRAPPERS */\r
 185 \r
 186 \r
 187 #endif /* MPU_WRAPPERS_H */\r