HeapP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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 ti_osal_HeapP__include
#define ti_osal_HeapP__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>


#define HeapP_BYTE_ALIGNMENT        (256U)

typedef enum HeapP_Status_e
{
    HeapP_OK         = 0,
    HeapP_FAILURE    = (-(int32_t)1)
} HeapP_Status;

typedef  void *HeapP_Handle;

typedef struct HeapP_Params_s
{
    void     *buf;          
    uint32_t size;          
} HeapP_Params;

typedef struct HeapP_MemStats_s
{
    uint32_t totalSize;         
    uint32_t totalFreeSize;     
    uint32_t largestFreeSize;   
} HeapP_MemStats;

extern void HeapP_Params_init(HeapP_Params *params);

extern HeapP_Handle HeapP_create(const HeapP_Params *params);

extern HeapP_Status HeapP_delete(HeapP_Handle handle);

extern void *HeapP_alloc(HeapP_Handle handle, uint32_t allocSize);

extern HeapP_Status HeapP_free(HeapP_Handle handle, void *ptr, uint32_t size);

extern HeapP_Status HeapP_getHeapStats(HeapP_Handle handle, HeapP_MemStats *stats);

#ifdef __cplusplus
}
#endif

#endif /* HEAPP_H */