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

   1 /*\r
   2  * FreeRTOS Kernel V10.4.3\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  * https://www.FreeRTOS.org\r
  23  * https://github.com/FreeRTOS\r
  24  *\r
  25  */\r
  26 \r
  27 /*-----------------------------------------------------------\r
  28 * Portable layer API.  Each function must be defined for each port.\r
  29 *----------------------------------------------------------*/\r
  30 \r
  31 #ifndef PORTABLE_H\r
  32 #define PORTABLE_H\r
  33 \r
  34 /* Each FreeRTOS port has a unique portmacro.h header file.  Originally a\r
  35  * pre-processor definition was used to ensure the pre-processor found the correct\r
  36  * portmacro.h file for the port being used.  That scheme was deprecated in favour\r
  37  * of setting the compiler's include path such that it found the correct\r
  38  * portmacro.h file - removing the need for the constant and allowing the\r
  39  * portmacro.h file to be located anywhere in relation to the port being used.\r
  40  * Purely for reasons of backward compatibility the old method is still valid, but\r
  41  * to make it clear that new projects should not use it, support for the port\r
  42  * specific constants has been moved into the deprecated_definitions.h header\r
  43  * file. */\r
  44 #include "deprecated_definitions.h"\r
  45 \r
  46 /* If portENTER_CRITICAL is not defined then including deprecated_definitions.h\r
  47  * did not result in a portmacro.h header file being included - and it should be\r
  48  * included here.  In this case the path to the correct portmacro.h header file\r
  49  * must be set in the compiler's include path. */\r
  50 #ifndef portENTER_CRITICAL\r
  51     #include "portmacro.h"\r
  52 #endif\r
  53 \r
  54 #if portBYTE_ALIGNMENT == 32\r
  55     #define portBYTE_ALIGNMENT_MASK    ( 0x001f )\r
  56 #elif portBYTE_ALIGNMENT == 16\r
  57     #define portBYTE_ALIGNMENT_MASK    ( 0x000f )\r
  58 #elif portBYTE_ALIGNMENT == 8\r
  59     #define portBYTE_ALIGNMENT_MASK    ( 0x0007 )\r
  60 #elif portBYTE_ALIGNMENT == 4\r
  61     #define portBYTE_ALIGNMENT_MASK    ( 0x0003 )\r
  62 #elif portBYTE_ALIGNMENT == 2\r
  63     #define portBYTE_ALIGNMENT_MASK    ( 0x0001 )\r
  64 #elif portBYTE_ALIGNMENT == 1\r
  65     #define portBYTE_ALIGNMENT_MASK    ( 0x0000 )\r
  66 #else\r
  67     #error "Invalid portBYTE_ALIGNMENT definition"\r
  68 #endif\r
  69 \r
  70 #ifndef portUSING_MPU_WRAPPERS\r
  71     #define portUSING_MPU_WRAPPERS 0\r
  72 #endif\r
  73 \r
  74 #ifndef portNUM_CONFIGURABLE_REGIONS\r
  75     #define portNUM_CONFIGURABLE_REGIONS    1\r
  76 #endif\r
  77 \r
  78 #ifndef portHAS_STACK_OVERFLOW_CHECKING\r
  79     #define portHAS_STACK_OVERFLOW_CHECKING    0\r
  80 #endif\r
  81 \r
  82 #ifndef portARCH_NAME\r
  83     #define portARCH_NAME    NULL\r
  84 #endif\r
  85 \r
  86 #ifndef configSTACK_ALLOCATION_FROM_SEPARATE_HEAP\r
  87     /* Defaults to 0 for backward compatibility. */\r
  88     #define configSTACK_ALLOCATION_FROM_SEPARATE_HEAP 0\r
  89 #endif\r
  90 \r
  91 /* *INDENT-OFF* */\r
  92 #ifdef __cplusplus\r
  93     extern "C" {\r
  94 #endif\r
  95 /* *INDENT-ON* */\r
  96 \r
  97 #include "mpu_wrappers.h"\r
  98 \r
  99 /*\r
 100  * Setup the stack of a new task so it is ready to be placed under the\r
 101  * scheduler control.  The registers have to be placed on the stack in\r
 102  * the order that the port expects to find them.\r
 103  *\r
 104  */\r
 105 #if ( portUSING_MPU_WRAPPERS == 1 )\r
 106     #if ( portHAS_STACK_OVERFLOW_CHECKING == 1 )\r
 107         StackType_t * pxPortInitialiseStack( StackType_t * pxTopOfStack,\r
 108                                              StackType_t * pxEndOfStack,\r
 109                                              TaskFunction_t pxCode,\r
 110                                              void * pvParameters,\r
 111                                              BaseType_t xRunPrivileged ) PRIVILEGED_FUNCTION;\r
 112     #else\r
 113         StackType_t * pxPortInitialiseStack( StackType_t * pxTopOfStack,\r
 114                                              TaskFunction_t pxCode,\r
 115                                              void * pvParameters,\r
 116                                              BaseType_t xRunPrivileged ) PRIVILEGED_FUNCTION;\r
 117     #endif\r
 118 #else /* if ( portUSING_MPU_WRAPPERS == 1 ) */\r
 119     #if ( portHAS_STACK_OVERFLOW_CHECKING == 1 )\r
 120         StackType_t * pxPortInitialiseStack( StackType_t * pxTopOfStack,\r
 121                                              StackType_t * pxEndOfStack,\r
 122                                              TaskFunction_t pxCode,\r
 123                                              void * pvParameters ) PRIVILEGED_FUNCTION;\r
 124     #else\r
 125         StackType_t * pxPortInitialiseStack( StackType_t * pxTopOfStack,\r
 126                                              TaskFunction_t pxCode,\r
 127                                              void * pvParameters ) PRIVILEGED_FUNCTION;\r
 128     #endif\r
 129 #endif /* if ( portUSING_MPU_WRAPPERS == 1 ) */\r
 130 \r
 131 /* Used by heap_5.c to define the start address and size of each memory region\r
 132  * that together comprise the total FreeRTOS heap space. */\r
 133 typedef struct HeapRegion\r
 134 {\r
 135     uint8_t * pucStartAddress;\r
 136     size_t xSizeInBytes;\r
 137 } HeapRegion_t;\r
 138 \r
 139 /* Used to pass information about the heap out of vPortGetHeapStats(). */\r
 140 typedef struct xHeapStats\r
 141 {\r
 142     size_t xAvailableHeapSpaceInBytes;          /* The total heap size currently available - this is the sum of all the free blocks, not the largest block that can be allocated. */\r
 143     size_t xSizeOfLargestFreeBlockInBytes;      /* The maximum size, in bytes, of all the free blocks within the heap at the time vPortGetHeapStats() is called. */\r
 144     size_t xSizeOfSmallestFreeBlockInBytes;     /* The minimum size, in bytes, of all the free blocks within the heap at the time vPortGetHeapStats() is called. */\r
 145     size_t xNumberOfFreeBlocks;                 /* The number of free memory blocks within the heap at the time vPortGetHeapStats() is called. */\r
 146     size_t xMinimumEverFreeBytesRemaining;      /* The minimum amount of total free memory (sum of all free blocks) there has been in the heap since the system booted. */\r
 147     size_t xNumberOfSuccessfulAllocations;      /* The number of calls to pvPortMalloc() that have returned a valid memory block. */\r
 148     size_t xNumberOfSuccessfulFrees;            /* The number of calls to vPortFree() that has successfully freed a block of memory. */\r
 149 } HeapStats_t;\r
 150 \r
 151 /*\r
 152  * Used to define multiple heap regions for use by heap_5.c.  This function\r
 153  * must be called before any calls to pvPortMalloc() - not creating a task,\r
 154  * queue, semaphore, mutex, software timer, event group, etc. will result in\r
 155  * pvPortMalloc being called.\r
 156  *\r
 157  * pxHeapRegions passes in an array of HeapRegion_t structures - each of which\r
 158  * defines a region of memory that can be used as the heap.  The array is\r
 159  * terminated by a HeapRegions_t structure that has a size of 0.  The region\r
 160  * with the lowest start address must appear first in the array.\r
 161  */\r
 162 void vPortDefineHeapRegions( const HeapRegion_t * const pxHeapRegions ) PRIVILEGED_FUNCTION;\r
 163 \r
 164 /*\r
 165  * Returns a HeapStats_t structure filled with information about the current\r
 166  * heap state.\r
 167  */\r
 168 void vPortGetHeapStats( HeapStats_t * pxHeapStats );\r
 169 \r
 170 /*\r
 171  * Map to the memory management routines required for the port.\r
 172  */\r
 173 void * pvPortMalloc( size_t xSize ) PRIVILEGED_FUNCTION;\r
 174 void vPortFree( void * pv ) PRIVILEGED_FUNCTION;\r
 175 void vPortInitialiseBlocks( void ) PRIVILEGED_FUNCTION;\r
 176 size_t xPortGetFreeHeapSize( void ) PRIVILEGED_FUNCTION;\r
 177 size_t xPortGetMinimumEverFreeHeapSize( void ) PRIVILEGED_FUNCTION;\r
 178 \r
 179 #if( configSTACK_ALLOCATION_FROM_SEPARATE_HEAP == 1 )\r
 180     void *pvPortMallocStack( size_t xSize ) PRIVILEGED_FUNCTION;\r
 181     void vPortFreeStack( void *pv ) PRIVILEGED_FUNCTION;\r
 182 #else\r
 183     #define pvPortMallocStack pvPortMalloc\r
 184     #define vPortFreeStack vPortFree\r
 185 #endif\r
 186 \r
 187 /*\r
 188  * Setup the hardware ready for the scheduler to take control.  This generally\r
 189  * sets up a tick interrupt and sets timers for the correct tick frequency.\r
 190  */\r
 191 BaseType_t xPortStartScheduler( void ) PRIVILEGED_FUNCTION;\r
 192 \r
 193 /*\r
 194  * Undo any hardware/ISR setup that was performed by xPortStartScheduler() so\r
 195  * the hardware is left in its original condition after the scheduler stops\r
 196  * executing.\r
 197  */\r
 198 void vPortEndScheduler( void ) PRIVILEGED_FUNCTION;\r
 199 \r
 200 /*\r
 201  * The structures and methods of manipulating the MPU are contained within the\r
 202  * port layer.\r
 203  *\r
 204  * Fills the xMPUSettings structure with the memory region information\r
 205  * contained in xRegions.\r
 206  */\r
 207 #if ( portUSING_MPU_WRAPPERS == 1 )\r
 208     struct xMEMORY_REGION;\r
 209     void vPortStoreTaskMPUSettings( xMPU_SETTINGS * xMPUSettings,\r
 210                                     const struct xMEMORY_REGION * const xRegions,\r
 211                                     StackType_t * pxBottomOfStack,\r
 212                                     uint32_t ulStackDepth ) PRIVILEGED_FUNCTION;\r
 213 #endif\r
 214 \r
 215 /* *INDENT-OFF* */\r
 216 #ifdef __cplusplus\r
 217     }\r
 218 #endif\r
 219 /* *INDENT-ON* */\r
 220 \r
 221 #endif /* PORTABLE_H */\r