HeapP.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2021 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef HEAPP_H
#define HEAPP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <sys/types.h>
#include <kernel/dpl/SystemP.h>
 
#define HeapP_BYTE_ALIGNMENT        (64u)
 
typedef struct HeapP_MemStats_
{
    size_t availableHeapSpaceInBytes;          
    size_t sizeOfLargestFreeBlockInBytes;      
    size_t sizeOfSmallestFreeBlockInBytes;     
    size_t numberOfFreeBlocks;                 
    size_t minimumEverFreeBytesRemaining;      
    size_t numberOfSuccessfulAllocations;      
    size_t numberOfSuccessfulFrees;            
} HeapP_MemStats;
 
typedef struct HEAP_BLOCK_LINK
{
    struct HEAP_BLOCK_LINK * pxNextFreeBlock; /* The next free block in the list. */
    size_t xBlockSize;                     /* The size of the free block. */
} HeapBlockLink_t;
 
typedef struct StaticHeap_ {
 
    /* Create a couple of list links to mark the start and end of the list. */
    HeapBlockLink_t xStart;
    HeapBlockLink_t *pxEnd;
 
    /* Keeps track of the number of calls to allocate and free memory as well as the
    * number of free bytes remaining, but says nothing about fragmentation. */
    size_t xFreeBytesRemaining;
    size_t xMinimumEverFreeBytesRemaining;
    size_t xNumberOfSuccessfulAllocations;
    size_t xNumberOfSuccessfulFrees;
 
    /* Gets set to the top bit of an size_t type.  When this bit in the xBlockSize
    * member of an HeapBlockLink_t structure is set then the block belongs to the
    * application.  When the bit is free the block is still part of the free heap
    * space. */
    size_t xBlockAllocatedBit;
 
    /* base address and size of heap */
    void *pvHeap;
    size_t xTotalHeapSize;
 
} StaticHeap_t;
 
#if defined (OS_FREERTOS) || defined (OS_FREERTOS_SMP) || defined (OS_FREERTOS_MPU)
 
#include <FreeRTOS.h>
#include <semphr.h>
 
typedef struct HeapP_Object_ {
    
    StaticHeap_t        heapHndl;
    StaticSemaphore_t   heapMutexObj;
    SemaphoreHandle_t   heapMutexHndl;
 
} HeapP_Object;
 
#else
 
typedef struct HeapP_Object_ {
 
    StaticHeap_t heapHndl;
 
} HeapP_Object;
 
#endif
 
 
int32_t HeapP_construct( HeapP_Object *heapObj, void *heapAddr, size_t heapSize );
 
void HeapP_destruct( HeapP_Object *heapObj);
 
void* HeapP_alloc( HeapP_Object *heapObj, size_t allocSize );
 
int32_t HeapP_free( HeapP_Object *heapObj, void * ptr );
 
size_t HeapP_getFreeHeapSize( HeapP_Object *heapObj );
 
size_t HeapP_getMinimumEverFreeHeapSize( HeapP_Object *heapObj );
 
int32_t HeapP_getHeapStats( HeapP_Object *heapObj, HeapP_MemStats * pHeapStats );
 
#ifdef __cplusplus
}
#endif
 
#endif /* HEAPP_H */