mpu_wrappers.h

Go to the documentation of this file.

/*
    FreeRTOS V9.0.0rc2 - Copyright (C) 2016 Real Time Engineers Ltd.
    All rights reserved

    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.

    This file is part of the FreeRTOS distribution.

    FreeRTOS is free software; you can redistribute it and/or modify it under
    the terms of the GNU General Public License (version 2) as published by the
    Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.

    ***************************************************************************
    >>!   NOTE: The modification to the GPL is included to allow you to     !<<
    >>!   distribute a combined work that includes FreeRTOS without being   !<<
    >>!   obliged to provide the source code for proprietary components     !<<
    >>!   outside of the FreeRTOS kernel.                                   !<<
    ***************************************************************************

    FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    FOR A PARTICULAR PURPOSE.  Full license text is available on the following
    link: http://www.freertos.org/a00114.html

    ***************************************************************************
     *                                                                       *
     *    FreeRTOS provides completely free yet professionally developed,    *
     *    robust, strictly quality controlled, supported, and cross          *
     *    platform software that is more than just the market leader, it     *
     *    is the industry's de facto standard.                               *
     *                                                                       *
     *    Help yourself get started quickly while simultaneously helping     *
     *    to support the FreeRTOS project by purchasing a FreeRTOS           *
     *    tutorial book, reference manual, or both:                          *
     *    http://www.FreeRTOS.org/Documentation                              *
     *                                                                       *
    ***************************************************************************

    http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading
    the FAQ page "My application does not run, what could be wrong?".  Have you
    defined configASSERT()?

    http://www.FreeRTOS.org/support - In return for receiving this top quality
    embedded software for free we request you assist our global community by
    participating in the support forum.

    http://www.FreeRTOS.org/training - Investing in training allows your team to
    be as productive as possible as early as possible.  Now you can receive
    FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
    Ltd, and the world's leading authority on the world's leading RTOS.

    http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
    including FreeRTOS+Trace - an indispensable productivity tool, a DOS
    compatible FAT file system, and our tiny thread aware UDP/IP stack.

    http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
    Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.

    http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
    Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS
    licenses offer ticketed support, indemnification and commercial middleware.

    http://www.SafeRTOS.com - High Integrity Systems also provide a safety
    engineered and independently SIL3 certified version for use in safety and
    mission critical applications that require provable dependability.

    1 tab == 4 spaces!
*/

#ifndef MPU_WRAPPERS_H
#define MPU_WRAPPERS_H

/* This file redefines API functions to be called through a wrapper macro, but
only for ports that are using the MPU. */
#ifdef portUSING_MPU_WRAPPERS

    /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE will be defined when this file is
    included from queue.c or task.c to prevent it from having an effect within
    those files. */
    #ifndef MPU_WRAPPERS_INCLUDED_FROM_API_FILE

        #define xTaskGenericCreate              MPU_xTaskGenericCreate
        #define vTaskAllocateMPURegions         MPU_vTaskAllocateMPURegions
        #define vTaskDelete                     MPU_vTaskDelete
        #define vTaskDelayUntil                 MPU_vTaskDelayUntil
        #define vTaskDelay                      MPU_vTaskDelay
        #define uxTaskPriorityGet               MPU_uxTaskPriorityGet
        #define vTaskPrioritySet                MPU_vTaskPrioritySet
        #define eTaskGetState                   MPU_eTaskGetState
        #define vTaskSuspend                    MPU_vTaskSuspend
        #define vTaskResume                     MPU_vTaskResume
        #define vTaskSuspendAll                 MPU_vTaskSuspendAll
        #define xTaskResumeAll                  MPU_xTaskResumeAll
        #define xTaskGetTickCount               MPU_xTaskGetTickCount
        #define uxTaskGetNumberOfTasks          MPU_uxTaskGetNumberOfTasks
        #define vTaskList                       MPU_vTaskList
        #define vTaskGetRunTimeStats            MPU_vTaskGetRunTimeStats
        #define vTaskSetApplicationTaskTag      MPU_vTaskSetApplicationTaskTag
        #define xTaskGetApplicationTaskTag      MPU_xTaskGetApplicationTaskTag
        #define xTaskCallApplicationTaskHook    MPU_xTaskCallApplicationTaskHook
        #define uxTaskGetStackHighWaterMark     MPU_uxTaskGetStackHighWaterMark
        #define xTaskGetCurrentTaskHandle       MPU_xTaskGetCurrentTaskHandle
        #define xTaskGetSchedulerState          MPU_xTaskGetSchedulerState
        #define xTaskGetIdleTaskHandle          MPU_xTaskGetIdleTaskHandle
        #define uxTaskGetSystemState            MPU_uxTaskGetSystemState
        #define xTaskGenericNotify              MPU_xTaskGenericNotify
        #define xTaskNotifyWait                 MPU_xTaskNotifyWait
        #define ulTaskNotifyTake                MPU_ulTaskNotifyTake

        #define xQueueGenericCreate             MPU_xQueueGenericCreate
        #define xQueueCreateMutex               MPU_xQueueCreateMutex
        #define xQueueGiveMutexRecursive        MPU_xQueueGiveMutexRecursive
        #define xQueueTakeMutexRecursive        MPU_xQueueTakeMutexRecursive
        #define xQueueCreateCountingSemaphore   MPU_xQueueCreateCountingSemaphore
        #define xQueueGenericSend               MPU_xQueueGenericSend
        #define xQueueGenericReceive            MPU_xQueueGenericReceive
        #define uxQueueMessagesWaiting          MPU_uxQueueMessagesWaiting
        #define vQueueDelete                    MPU_vQueueDelete
        #define xQueueGenericReset              MPU_xQueueGenericReset
        #define xQueueCreateSet                 MPU_xQueueCreateSet
        #define xQueueSelectFromSet             MPU_xQueueSelectFromSet
        #define xQueueAddToSet                  MPU_xQueueAddToSet
        #define xQueueRemoveFromSet             MPU_xQueueRemoveFromSet
        #define xQueueGetMutexHolder            MPU_xQueueGetMutexHolder

        #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
            #define pvPortMalloc                    MPU_pvPortMalloc
            #define vPortFree                       MPU_vPortFree
        #endif /* configSUPPORT_DYNAMIC_ALLOCATION */

        #define xPortGetFreeHeapSize            MPU_xPortGetFreeHeapSize
        #define vPortInitialiseBlocks           MPU_vPortInitialiseBlocks
        #define xPortGetMinimumEverFreeHeapSize MPU_xPortGetMinimumEverFreeHeapSize

        #if configQUEUE_REGISTRY_SIZE > 0
            #define vQueueAddToRegistry             MPU_vQueueAddToRegistry
            #define vQueueUnregisterQueue           MPU_vQueueUnregisterQueue
        #endif

        #define xTimerCreate                    MPU_xTimerCreate
        #define pvTimerGetTimerID               MPU_pvTimerGetTimerID
        #define vTimerSetTimerID                MPU_vTimerSetTimerID
        #define xTimerIsTimerActive             MPU_xTimerIsTimerActive
        #define xTimerGetTimerDaemonTaskHandle  MPU_xTimerGetTimerDaemonTaskHandle
        #define xTimerPendFunctionCall          MPU_xTimerPendFunctionCall
        #define pcTimerGetName                  MPU_pcTimerGetName
        #define xTimerGenericCommand            MPU_xTimerGenericCommand

        #define xEventGroupCreate               MPU_xEventGroupCreate
        #define xEventGroupWaitBits             MPU_xEventGroupWaitBits
        #define xEventGroupClearBits            MPU_xEventGroupClearBits
        #define xEventGroupSetBits              MPU_xEventGroupSetBits
        #define xEventGroupSync                 MPU_xEventGroupSync
        #define vEventGroupDelete               MPU_vEventGroupDelete

        /* Remove the privileged function macro. */
        #define PRIVILEGED_FUNCTION

    #else /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE */

        /* Ensure API functions go in the privileged execution section. */
        #define PRIVILEGED_FUNCTION __attribute__((section("privileged_functions")))
        #define PRIVILEGED_DATA __attribute__((section("privileged_data")))

    #endif /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE */

#else /* portUSING_MPU_WRAPPERS */

    #define PRIVILEGED_FUNCTION
    #define PRIVILEGED_DATA
    #define portUSING_MPU_WRAPPERS 0

#endif /* portUSING_MPU_WRAPPERS */


#endif /* MPU_WRAPPERS_H */