AM64x MCU+ SDK  10.00.00
HeapP.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018-2021 Texas Instruments Incorporated
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef HEAPP_H
34 #define HEAPP_H
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 #include <stdint.h>
41 #include <sys/types.h>
42 #include <kernel/dpl/SystemP.h>
43 
54 #define HeapP_BYTE_ALIGNMENT (64u)
55 
59 typedef struct HeapP_MemStats_
60 {
69 
73 #define HeapP_OBJECT_SIZE_MAX (128U)
74 
77 typedef struct HeapP_Object_ {
78 
79  uint32_t rsv[HeapP_OBJECT_SIZE_MAX/sizeof(uint32_t)];
81 } HeapP_Object;
82 
93 void HeapP_construct( HeapP_Object *heap, void *heapAddr, size_t heapSize );
94 
101 
111 void *HeapP_alloc( HeapP_Object *heap, size_t allocSize );
112 
120 void HeapP_free( HeapP_Object *heap, void * ptr );
121 
130 
139 
146 void HeapP_getHeapStats( HeapP_Object *heap, HeapP_MemStats * pHeapStats );
147 
150 #ifdef __cplusplus
151 }
152 #endif
153 
154 #endif /* HEAPP_H */
HeapP_free
void HeapP_free(HeapP_Object *heap, void *ptr)
Free memory from user defined heap.
SystemP.h
HeapP_getMinimumEverFreeHeapSize
size_t HeapP_getMinimumEverFreeHeapSize(HeapP_Object *heap)
Get lowest ever free heap size, in bytes.
HeapP_destruct
void HeapP_destruct(HeapP_Object *heap)
Delete the user defined heap.
HeapP_getFreeHeapSize
size_t HeapP_getFreeHeapSize(HeapP_Object *heap)
Get free heap size, in bytes.
HeapP_construct
void HeapP_construct(HeapP_Object *heap, void *heapAddr, size_t heapSize)
Create a user defined heap.
HeapP_MemStats::minimumEverFreeBytesRemaining
size_t minimumEverFreeBytesRemaining
Definition: HeapP.h:65
HeapP_MemStats::numberOfFreeBlocks
size_t numberOfFreeBlocks
Definition: HeapP.h:64
HeapP_MemStats::sizeOfLargestFreeBlockInBytes
size_t sizeOfLargestFreeBlockInBytes
Definition: HeapP.h:62
HeapP_alloc
void * HeapP_alloc(HeapP_Object *heap, size_t allocSize)
Alloc memory from user defined heap.
HeapP_MemStats::sizeOfSmallestFreeBlockInBytes
size_t sizeOfSmallestFreeBlockInBytes
Definition: HeapP.h:63
HeapP_MemStats::numberOfSuccessfulFrees
size_t numberOfSuccessfulFrees
Definition: HeapP.h:67
HeapP_getHeapStats
void HeapP_getHeapStats(HeapP_Object *heap, HeapP_MemStats *pHeapStats)
Get detailed heap statistics.
HeapP_MemStats::availableHeapSpaceInBytes
size_t availableHeapSpaceInBytes
Definition: HeapP.h:61
HeapP_MemStats
Structure used to pass information about the heap out of HeapP_getHeapStats().
Definition: HeapP.h:60
HeapP_OBJECT_SIZE_MAX
#define HeapP_OBJECT_SIZE_MAX
Max size of heap object across no-RTOS and all OS's.
Definition: HeapP.h:73
HeapP_MemStats::numberOfSuccessfulAllocations
size_t numberOfSuccessfulAllocations
Definition: HeapP.h:66
HeapP_Object
Opaque heap object used with the heap APIs.
Definition: HeapP.h:77