app_mem.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) 2017-2025 Texas Instruments Incorporated
 *
 * All rights reserved not granted herein.
 *
 * Limited License.
 *
 * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
 * license under copyrights and patents it now or hereafter owns or controls to make,
 * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
 * terms herein.  With respect to the foregoing patent license, such license is granted
 * solely to the extent that any such patent is necessary to Utilize the software alone.
 * The patent license shall not apply to any combinations which include this software,
 * other than combinations with devices manufactured by or for TI ("TI Devices").
 * No hardware patent is licensed hereunder.
 *
 * Redistributions must preserve existing copyright notices and reproduce this license
 * (including the above copyright notice and the disclaimer and (if applicable) source
 * code license limitations below) in the documentation and/or other materials provided
 * with the distribution
 *
 * Redistribution and use in binary form, without modification, are permitted provided
 * that the following conditions are met:
 *
 * *       No reverse engineering, decompilation, or disassembly of this software is
 * permitted with respect to any software provided in binary form.
 *
 * *       any redistribution and use are licensed by TI for use only with TI Devices.
 *
 * *       Nothing shall obligate TI to provide you with source code for the software
 * licensed and provided to you in object code.
 *
 * If software source code is provided to you, modification and redistribution of the
 * source code are permitted provided that the following conditions are met:
 *
 * *       any redistribution and use of the source code, including any resulting derivative
 * works, are licensed by TI for use only with TI Devices.
 *
 * *       any redistribution and use of any object code compiled from the source code
 * and any resulting derivative works, are licensed by TI for use only with TI Devices.
 *
 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
 *
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * DISCLAIMER.
 *
 * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "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 TI AND TI'S LICENSORS 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 APP_MEM_H_
#define APP_MEM_H_

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

#if defined(FREERTOS) || defined(SAFERTOS) || defined(THREADX)
#if defined(MCU_PLUS_SDK)
#if defined(HOST_EMULATION)
#include <drivers/dmautils/udma_standalone/udma.h>
#else
#include <drivers/udma.h>
#include <drivers/udma/udma_priv.h>
#endif
#else
#include <ti/drv/udma/udma.h>
#endif
#endif

#if defined(R5F) && (defined(SOC_J784S4) || defined(SOC_J721S2) || defined(SOC_J742S2))
#include <ti/csl/csl_rat.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

#define APP_MEM_HEAP_NAME_MAX   (16u)

typedef uint64_t (*app_mem_shared_target_fxn)(const uint64_t sharedAddr);

typedef uint64_t (*app_mem_target_shared_fxn)(const uint64_t targetAddr);

#define APP_MEM_HEAP_DDR        (0u)

#define APP_MEM_HEAP_L3         (1u)

#define APP_MEM_HEAP_L2         (2u)

#define APP_MEM_HEAP_L1         (3u)

#define APP_MEM_HEAP_DDR_SCRATCH (4u)

#define APP_MEM_HEAP_DDR_NON_CACHE  (5u)

#define APP_MEM_HEAP_DDR_NON_CACHE_SCRATCH  (6u)

#define APP_MEM_HEAP_DDR_WT_CACHE  (7u)

#define APP_MEM_HEAP_MAX        (8u)

/* @} */

#define APP_MEM_HEAP_FLAGS_TYPE_LINEAR_ALLOCATE     (0x00000001u)

#define APP_MEM_HEAP_FLAGS_IS_SHARED                (0x00000004u)

#define APP_MEM_HEAP_FLAGS_DO_CLEAR_ON_ALLOC        (0x00000008u)

/* @} */

typedef struct {

    void    *base;                   
    char    name[APP_MEM_HEAP_NAME_MAX];  
    uint32_t size;                   
    uint32_t flags;                  
} app_mem_heap_prm_t;

typedef struct {

    app_mem_heap_prm_t heap_info[APP_MEM_HEAP_MAX]; 
    #if defined(FREERTOS) || defined(SAFERTOS) || defined(THREADX)
    Udma_VirtToPhyFxn           virtToPhyFxn;
    app_mem_shared_target_fxn   shared2TargetFxn;
    app_mem_target_shared_fxn   target2SharedFxn;
    #endif
    #if defined(R5F) && (defined(SOC_J784S4) || defined(SOC_J721S2) || defined(SOC_J742S2))

    CSL_ratRegs *pRatRegs;
    #endif
    #if defined(A72) || defined(A53) || defined(PC)
    uint64_t base;                   
    uint32_t size;                   
    #endif
} app_mem_init_prm_t;


typedef struct {

    uint32_t heap_id;                       
    char heap_name[APP_MEM_HEAP_NAME_MAX];  
    uint32_t heap_size;                     
    uint32_t free_size;                     
} app_mem_stats_t;

#if defined(R5F) && (defined(SOC_J784S4) || defined(SOC_J721S2) || defined(SOC_J742S2))

typedef struct {
    uint64_t size;
    uint64_t translatedAddress;
    uint32_t baseAddress;
} app_mem_rat_prm_t;
#endif

static inline void *APP_MEM_ALIGNPTR(void *val, uint32_t align);
static inline uint64_t APP_MEM_ALIGN64(uint64_t val, uint32_t align);
static inline uint32_t APP_MEM_ALIGN32(uint32_t val, uint32_t align);

static inline void *APP_MEM_ALIGNPTR(void *val, uint32_t align)
{
    return (void*)((((uintptr_t)val+align-1u) / align) * align);
}

static inline uint64_t APP_MEM_ALIGN64(uint64_t val, uint32_t align)
{
    return (uint64_t)( (uint64_t)(val+align-1u) / align) * align;
}

static inline uint32_t APP_MEM_ALIGN32(uint32_t val, uint32_t align)
{
    return (uint32_t)( (uint32_t)(val+align-1u) / align) * align;
}

#if defined(__C7120__) && (defined(SOC_J784S4) || defined(SOC_J742S2))

void appMemC7xSetL2WBINV(uint64_t param);

uint64_t appMemC7xGetL2WBINV(void);

void appMemC7xCleaninvalidateL2Cache(void);

void appMemC7xSetL1DWBINV(uint64_t param);

uint64_t appMemC7xGetL1DWBINV(void);

void appMemC7xCleaninvalidateL1DCache(void);
#endif

void static inline appMemEnableL1DandL2CacheWb(void)
{
#if defined(__C7120__) && (defined(SOC_J784S4) || defined(SOC_J742S2))
  appMemC7xCleaninvalidateL1DCache();
  appMemC7xCleaninvalidateL2Cache();
#endif
}

void    appMemInitPrmSetDefault(app_mem_init_prm_t *prm);

int32_t appMemInit(app_mem_init_prm_t *prm);

int32_t appMemDeInit(void);

void    *appMemAlloc(uint32_t heap_id, uint32_t size, uint32_t align);

bool appMemRegionQuery(uint32_t heap_id);

int32_t tivxMemRegionTranslate (uint32_t mem_heap_region, uint32_t *heap_id);


int32_t appMemResetScratchHeap(uint32_t heap_id);

int32_t appMemFree(uint32_t heap_id, void *ptr, uint32_t size);

#if defined(x86_64) || defined(QNX)
uint64_t appMemGetDmaBufFd(void *virPtr, volatile uint32_t *dmaBufFdOffset);
#else
uint32_t appMemGetDmaBufFd(void *virPtr, volatile uint32_t *dmaBufFdOffset);
#endif

#if defined(x86_64) || defined(QNX)
int32_t appMemTranslateDmaBufFd(uint64_t dmaBufFd, uint32_t size, uint64_t *virtPtr, uint64_t *phyPtr);
#else
int32_t appMemTranslateDmaBufFd(uint32_t dmaBufFd, uint32_t size, uint64_t *virtPtr, uint64_t *phyPtr);
#endif

#if defined(x86_64) || defined(QNX)
void appMemCloseDmaBufFd(uint64_t dmaBufFd);
#else
void appMemCloseDmaBufFd(uint32_t dmaBufFd);
#endif

uint64_t appMemGetVirt2PhyBufPtr(uint64_t virtPtr, uint32_t heap_id);

int32_t appMemStats(uint32_t heap_id, app_mem_stats_t *stats);

void  appMemCacheInv(void *ptr, uint32_t size);

void  appMemCacheWb(void *ptr, uint32_t size);

void  appMemCacheWbInv(void *ptr, uint32_t size);

void appMemPrintMemAllocInfo(void);

uint64_t appMemShared2PhysPtr(uint64_t shared_ptr, uint32_t heap_id);

uint64_t appMemShared2TargetPtr(uint64_t shared_ptr);


void     *appMemMap(void *phys_addr, uint32_t size);

int32_t   appMemUnMap(void *virt_addr, uint32_t size);

uint32_t appMemGetNumAllocs(void);

#if defined(R5F) && (defined(SOC_J784S4) || defined(SOC_J721S2) || defined(SOC_J742S2))

int32_t appMemAddrTranslate(app_mem_rat_prm_t *prm);

int32_t appMemSetRatRegs(CSL_ratRegs *pRatRegs);
#endif

#if defined(x86_64)

int32_t appMemSetFdPath(char *path, uint32_t size);
#endif


/* @} */

#ifdef __cplusplus
}
#endif

#endif