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

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