2 FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.
\r
5 ***************************************************************************
\r
7 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
8 * Complete, revised, and edited pdf reference manuals are also *
\r
11 * Purchasing FreeRTOS documentation will not only help you, by *
\r
12 * ensuring you get running as quickly as possible and with an *
\r
13 * in-depth knowledge of how to use FreeRTOS, it will also help *
\r
14 * the FreeRTOS project to continue with its mission of providing *
\r
15 * professional grade, cross platform, de facto standard solutions *
\r
16 * for microcontrollers - completely free of charge! *
\r
18 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
20 * Thank you for using FreeRTOS, and thank you for your support! *
\r
22 ***************************************************************************
\r
25 This file is part of the FreeRTOS distribution.
\r
27 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
28 the terms of the GNU General Public License (version 2) as published by the
\r
29 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
30 >>>NOTE<<< The modification to the GPL is included to allow you to
\r
31 distribute a combined work that includes FreeRTOS without being obliged to
\r
32 provide the source code for proprietary components outside of the FreeRTOS
\r
33 kernel. FreeRTOS is distributed in the hope that it will be useful, but
\r
34 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
\r
35 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
36 more details. You should have received a copy of the GNU General Public
\r
37 License and the FreeRTOS license exception along with FreeRTOS; if not it
\r
38 can be viewed here: http://www.freertos.org/a00114.html and also obtained
\r
39 by writing to Richard Barry, contact details for whom are available on the
\r
44 ***************************************************************************
\r
46 * Having a problem? Start by reading the FAQ "My application does *
\r
47 * not run, what could be wrong? *
\r
49 * http://www.FreeRTOS.org/FAQHelp.html *
\r
51 ***************************************************************************
\r
54 http://www.FreeRTOS.org - Documentation, training, latest information,
\r
55 license and contact details.
\r
57 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
58 including FreeRTOS+Trace - an indispensable productivity tool.
\r
60 Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell
\r
61 the code with commercial support, indemnification, and middleware, under
\r
62 the OpenRTOS brand: http://www.OpenRTOS.com. High Integrity Systems also
\r
63 provide a safety engineered and independently SIL3 certified version under
\r
64 the SafeRTOS brand: http://www.SafeRTOS.com.
\r
68 * A sample implementation of pvPortMalloc() and vPortFree() that permits
\r
69 * allocated blocks to be freed, but does not combine adjacent free blocks
\r
70 * into a single larger block.
\r
72 * See heap_1.c and heap_3.c for alternative implementations, and the memory
\r
73 * management pages of http://www.FreeRTOS.org for more information.
\r
77 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining
\r
78 all the API functions to use the MPU wrappers. That should only be done when
\r
79 task.h is included from an application file. */
\r
80 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE
\r
82 #include "FreeRTOS.h"
\r
85 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE
\r
87 /* Allocate the memory for the heap. The struct is used to force byte
\r
88 alignment without using any non-portable code. */
\r
89 static union xRTOS_HEAP
\r
91 #if portBYTE_ALIGNMENT == 8
\r
92 volatile portDOUBLE dDummy;
\r
94 volatile unsigned long ulDummy;
\r
96 unsigned char ucHeap[ configTOTAL_HEAP_SIZE ];
\r
99 /* Define the linked list structure. This is used to link free blocks in order
\r
101 typedef struct A_BLOCK_LINK
\r
103 struct A_BLOCK_LINK *pxNextFreeBlock; /*<< The next free block in the list. */
\r
104 size_t xBlockSize; /*<< The size of the free block. */
\r
108 static const unsigned short heapSTRUCT_SIZE = ( sizeof( xBlockLink ) + portBYTE_ALIGNMENT - ( sizeof( xBlockLink ) % portBYTE_ALIGNMENT ) );
\r
109 #define heapMINIMUM_BLOCK_SIZE ( ( size_t ) ( heapSTRUCT_SIZE * 2 ) )
\r
111 /* Create a couple of list links to mark the start and end of the list. */
\r
112 static xBlockLink xStart, xEnd;
\r
114 /* Keeps track of the number of free bytes remaining, but says nothing about
\r
116 static size_t xFreeBytesRemaining = configTOTAL_HEAP_SIZE;
\r
118 /* STATIC FUNCTIONS ARE DEFINED AS MACROS TO MINIMIZE THE FUNCTION CALL DEPTH. */
\r
121 * Insert a block into the list of free blocks - which is ordered by size of
\r
122 * the block. Small blocks at the start of the list and large blocks at the end
\r
125 #define prvInsertBlockIntoFreeList( pxBlockToInsert ) \
\r
127 xBlockLink *pxIterator; \
\r
128 size_t xBlockSize; \
\r
130 xBlockSize = pxBlockToInsert->xBlockSize; \
\r
132 /* Iterate through the list until a block is found that has a larger size */ \
\r
133 /* than the block we are inserting. */ \
\r
134 for( pxIterator = &xStart; pxIterator->pxNextFreeBlock->xBlockSize < xBlockSize; pxIterator = pxIterator->pxNextFreeBlock ) \
\r
136 /* There is nothing to do here - just iterate to the correct position. */ \
\r
139 /* Update the list to include the block being inserted in the correct */ \
\r
141 pxBlockToInsert->pxNextFreeBlock = pxIterator->pxNextFreeBlock; \
\r
142 pxIterator->pxNextFreeBlock = pxBlockToInsert; \
\r
144 /*-----------------------------------------------------------*/
\r
146 #define prvHeapInit() \
\r
148 xBlockLink *pxFirstFreeBlock; \
\r
150 /* xStart is used to hold a pointer to the first item in the list of free */ \
\r
151 /* blocks. The void cast is used to prevent compiler warnings. */ \
\r
152 xStart.pxNextFreeBlock = ( void * ) xHeap.ucHeap; \
\r
153 xStart.xBlockSize = ( size_t ) 0; \
\r
155 /* xEnd is used to mark the end of the list of free blocks. */ \
\r
156 xEnd.xBlockSize = configTOTAL_HEAP_SIZE; \
\r
157 xEnd.pxNextFreeBlock = NULL; \
\r
159 /* To start with there is a single free block that is sized to take up the \
\r
160 entire heap space. */ \
\r
161 pxFirstFreeBlock = ( void * ) xHeap.ucHeap; \
\r
162 pxFirstFreeBlock->xBlockSize = configTOTAL_HEAP_SIZE; \
\r
163 pxFirstFreeBlock->pxNextFreeBlock = &xEnd; \
\r
165 /*-----------------------------------------------------------*/
\r
167 void *pvPortMalloc( size_t xWantedSize )
\r
169 xBlockLink *pxBlock, *pxPreviousBlock, *pxNewBlockLink;
\r
170 static portBASE_TYPE xHeapHasBeenInitialised = pdFALSE;
\r
171 void *pvReturn = NULL;
\r
175 /* If this is the first call to malloc then the heap will require
\r
176 initialisation to setup the list of free blocks. */
\r
177 if( xHeapHasBeenInitialised == pdFALSE )
\r
180 xHeapHasBeenInitialised = pdTRUE;
\r
183 /* The wanted size is increased so it can contain a xBlockLink
\r
184 structure in addition to the requested amount of bytes. */
\r
185 if( xWantedSize > 0 )
\r
187 xWantedSize += heapSTRUCT_SIZE;
\r
189 /* Ensure that blocks are always aligned to the required number of bytes. */
\r
190 if( xWantedSize & portBYTE_ALIGNMENT_MASK )
\r
192 /* Byte alignment required. */
\r
193 xWantedSize += ( portBYTE_ALIGNMENT - ( xWantedSize & portBYTE_ALIGNMENT_MASK ) );
\r
197 if( ( xWantedSize > 0 ) && ( xWantedSize < configTOTAL_HEAP_SIZE ) )
\r
199 /* Blocks are stored in byte order - traverse the list from the start
\r
200 (smallest) block until one of adequate size is found. */
\r
201 pxPreviousBlock = &xStart;
\r
202 pxBlock = xStart.pxNextFreeBlock;
\r
203 while( ( pxBlock->xBlockSize < xWantedSize ) && ( pxBlock->pxNextFreeBlock ) )
\r
205 pxPreviousBlock = pxBlock;
\r
206 pxBlock = pxBlock->pxNextFreeBlock;
\r
209 /* If we found the end marker then a block of adequate size was not found. */
\r
210 if( pxBlock != &xEnd )
\r
212 /* Return the memory space - jumping over the xBlockLink structure
\r
214 pvReturn = ( void * ) ( ( ( unsigned char * ) pxPreviousBlock->pxNextFreeBlock ) + heapSTRUCT_SIZE );
\r
216 /* This block is being returned for use so must be taken our of the
\r
217 list of free blocks. */
\r
218 pxPreviousBlock->pxNextFreeBlock = pxBlock->pxNextFreeBlock;
\r
220 /* If the block is larger than required it can be split into two. */
\r
221 if( ( pxBlock->xBlockSize - xWantedSize ) > heapMINIMUM_BLOCK_SIZE )
\r
223 /* This block is to be split into two. Create a new block
\r
224 following the number of bytes requested. The void cast is
\r
225 used to prevent byte alignment warnings from the compiler. */
\r
226 pxNewBlockLink = ( void * ) ( ( ( unsigned char * ) pxBlock ) + xWantedSize );
\r
228 /* Calculate the sizes of two blocks split from the single
\r
230 pxNewBlockLink->xBlockSize = pxBlock->xBlockSize - xWantedSize;
\r
231 pxBlock->xBlockSize = xWantedSize;
\r
233 /* Insert the new block into the list of free blocks. */
\r
234 prvInsertBlockIntoFreeList( ( pxNewBlockLink ) );
\r
237 xFreeBytesRemaining -= pxBlock->xBlockSize;
\r
243 #if( configUSE_MALLOC_FAILED_HOOK == 1 )
\r
245 if( pvReturn == NULL )
\r
247 extern void vApplicationMallocFailedHook( void );
\r
248 vApplicationMallocFailedHook();
\r
255 /*-----------------------------------------------------------*/
\r
257 void vPortFree( void *pv )
\r
259 unsigned char *puc = ( unsigned char * ) pv;
\r
260 xBlockLink *pxLink;
\r
264 /* The memory being freed will have an xBlockLink structure immediately
\r
266 puc -= heapSTRUCT_SIZE;
\r
268 /* This casting is to keep the compiler from issuing warnings. */
\r
269 pxLink = ( void * ) puc;
\r
273 /* Add this block to the list of free blocks. */
\r
274 prvInsertBlockIntoFreeList( ( ( xBlockLink * ) pxLink ) );
\r
275 xFreeBytesRemaining += pxLink->xBlockSize;
\r
280 /*-----------------------------------------------------------*/
\r
282 size_t xPortGetFreeHeapSize( void )
\r
284 return xFreeBytesRemaining;
\r
286 /*-----------------------------------------------------------*/
\r
288 void vPortInitialiseBlocks( void )
\r
290 /* This just exists to keep the linker quiet. */
\r