begriffs open source - cmsis-freertos/blob - Source/include/portable.h

   1 /*
   2  * FreeRTOS Kernel V10.2.0
   3  * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
   9  * the Software, and to permit persons to whom the Software is furnished to do so,
  10  * subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * http://www.FreeRTOS.org
  23  * http://aws.amazon.com/freertos
  24  *
  25  * 1 tab == 4 spaces!
  26  */
  27
  28 /*-----------------------------------------------------------
  29  * Portable layer API.  Each function must be defined for each port.
  30  *----------------------------------------------------------*/
  31
  32 #ifndef PORTABLE_H
  33 #define PORTABLE_H
  34
  35 /* Each FreeRTOS port has a unique portmacro.h header file.  Originally a
  36 pre-processor definition was used to ensure the pre-processor found the correct
  37 portmacro.h file for the port being used.  That scheme was deprecated in favour
  38 of setting the compiler's include path such that it found the correct
  39 portmacro.h file - removing the need for the constant and allowing the
  40 portmacro.h file to be located anywhere in relation to the port being used.
  41 Purely for reasons of backward compatibility the old method is still valid, but
  42 to make it clear that new projects should not use it, support for the port
  43 specific constants has been moved into the deprecated_definitions.h header
  44 file. */
  45 #include "deprecated_definitions.h"
  46
  47 /* If portENTER_CRITICAL is not defined then including deprecated_definitions.h
  48 did not result in a portmacro.h header file being included - and it should be
  49 included here.  In this case the path to the correct portmacro.h header file
  50 must be set in the compiler's include path. */
  51 #ifndef portENTER_CRITICAL
  52         #include "portmacro.h"
  53 #endif
  54
  55 #if portBYTE_ALIGNMENT == 32
  56         #define portBYTE_ALIGNMENT_MASK ( 0x001f )
  57 #endif
  58
  59 #if portBYTE_ALIGNMENT == 16
  60         #define portBYTE_ALIGNMENT_MASK ( 0x000f )
  61 #endif
  62
  63 #if portBYTE_ALIGNMENT == 8
  64         #define portBYTE_ALIGNMENT_MASK ( 0x0007 )
  65 #endif
  66
  67 #if portBYTE_ALIGNMENT == 4
  68         #define portBYTE_ALIGNMENT_MASK ( 0x0003 )
  69 #endif
  70
  71 #if portBYTE_ALIGNMENT == 2
  72         #define portBYTE_ALIGNMENT_MASK ( 0x0001 )
  73 #endif
  74
  75 #if portBYTE_ALIGNMENT == 1
  76         #define portBYTE_ALIGNMENT_MASK ( 0x0000 )
  77 #endif
  78
  79 #ifndef portBYTE_ALIGNMENT_MASK
  80         #error "Invalid portBYTE_ALIGNMENT definition"
  81 #endif
  82
  83 #ifndef portNUM_CONFIGURABLE_REGIONS
  84         #define portNUM_CONFIGURABLE_REGIONS 1
  85 #endif
  86
  87 #ifdef __cplusplus
  88 extern "C" {
  89 #endif
  90
  91 #include "mpu_wrappers.h"
  92
  93 /*
  94  * Setup the stack of a new task so it is ready to be placed under the
  95  * scheduler control.  The registers have to be placed on the stack in
  96  * the order that the port expects to find them.
  97  *
  98  */
  99 #if( portUSING_MPU_WRAPPERS == 1 )
 100         #if( portHAS_STACK_OVERFLOW_CHECKING == 1 )
 101                 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, StackType_t *pxEndOfStack, TaskFunction_t pxCode, void *pvParameters, BaseType_t xRunPrivileged ) PRIVILEGED_FUNCTION;
 102         #else
 103                 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters, BaseType_t xRunPrivileged ) PRIVILEGED_FUNCTION;
 104         #endif
 105 #else
 106         #if( portHAS_STACK_OVERFLOW_CHECKING == 1 )
 107                 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, StackType_t *pxEndOfStack, TaskFunction_t pxCode, void *pvParameters ) PRIVILEGED_FUNCTION;
 108         #else
 109                 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters ) PRIVILEGED_FUNCTION;
 110         #endif
 111 #endif
 112
 113 /* Used by heap_5.c. */
 114 typedef struct HeapRegion
 115 {
 116         uint8_t *pucStartAddress;
 117         size_t xSizeInBytes;
 118 } HeapRegion_t;
 119
 120 /*
 121  * Used to define multiple heap regions for use by heap_5.c.  This function
 122  * must be called before any calls to pvPortMalloc() - not creating a task,
 123  * queue, semaphore, mutex, software timer, event group, etc. will result in
 124  * pvPortMalloc being called.
 125  *
 126  * pxHeapRegions passes in an array of HeapRegion_t structures - each of which
 127  * defines a region of memory that can be used as the heap.  The array is
 128  * terminated by a HeapRegions_t structure that has a size of 0.  The region
 129  * with the lowest start address must appear first in the array.
 130  */
 131 void vPortDefineHeapRegions( const HeapRegion_t * const pxHeapRegions ) PRIVILEGED_FUNCTION;
 132
 133
 134 /*
 135  * Map to the memory management routines required for the port.
 136  */
 137 void *pvPortMalloc( size_t xSize ) PRIVILEGED_FUNCTION;
 138 void vPortFree( void *pv ) PRIVILEGED_FUNCTION;
 139 void vPortInitialiseBlocks( void ) PRIVILEGED_FUNCTION;
 140 size_t xPortGetFreeHeapSize( void ) PRIVILEGED_FUNCTION;
 141 size_t xPortGetMinimumEverFreeHeapSize( void ) PRIVILEGED_FUNCTION;
 142
 143 /*
 144  * Setup the hardware ready for the scheduler to take control.  This generally
 145  * sets up a tick interrupt and sets timers for the correct tick frequency.
 146  */
 147 BaseType_t xPortStartScheduler( void ) PRIVILEGED_FUNCTION;
 148
 149 /*
 150  * Undo any hardware/ISR setup that was performed by xPortStartScheduler() so
 151  * the hardware is left in its original condition after the scheduler stops
 152  * executing.
 153  */
 154 void vPortEndScheduler( void ) PRIVILEGED_FUNCTION;
 155
 156 /*
 157  * The structures and methods of manipulating the MPU are contained within the
 158  * port layer.
 159  *
 160  * Fills the xMPUSettings structure with the memory region information
 161  * contained in xRegions.
 162  */
 163 #if( portUSING_MPU_WRAPPERS == 1 )
 164         struct xMEMORY_REGION;
 165         void vPortStoreTaskMPUSettings( xMPU_SETTINGS *xMPUSettings, const struct xMEMORY_REGION * const xRegions, StackType_t *pxBottomOfStack, uint32_t ulStackDepth ) PRIVILEGED_FUNCTION;
 166 #endif
 167
 168 #ifdef __cplusplus
 169 }
 170 #endif
 171
 172 #endif /* PORTABLE_H */
 173