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