tivx_mem.h

Go to the documentation of this file.

/*
*
* Copyright (c) 2017-2019 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 TIVX_MEM_H_
#define TIVX_MEM_H_

#include <VX/vx.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum _tivx_mem_heap_region_e
{
    TIVX_MEM_EXTERNAL,

    TIVX_MEM_INTERNAL_L3,

    TIVX_MEM_INTERNAL_L2,

    TIVX_MEM_INTERNAL_L1,

    TIVX_MEM_EXTERNAL_SCRATCH,

    TIVX_MEM_EXTERNAL_PERSISTENT_NON_CACHEABLE,
    TIVX_MEM_EXTERNAL_SCRATCH_NON_CACHEABLE,
    TIVX_MEM_EXTERNAL_CACHEABLE_WT

} tivx_mem_heap_region_e;

typedef enum _tivx_memory_type_e {
    TIVX_MEMORY_TYPE_DMA = VX_ENUM_BASE(VX_ID_TI, VX_ENUM_MEMORY_TYPE) + 0x0,
} tivx_memory_type_e;

typedef struct _tivx_shared_mem_ptr_t {

    volatile uint32_t mem_heap_region;

    volatile int32_t dma_buf_fd;

    volatile uint64_t shared_ptr;

    volatile uint64_t host_ptr;

    volatile uint32_t dma_buf_fd_offset;

    /* Padding to align to 64 bytes */
    volatile uint32_t rsv[1];

} tivx_shared_mem_ptr_t;

typedef struct _tivx_mem_stats_t {

    vx_uint32 mem_size;

    vx_uint32 free_size;

} tivx_mem_stats;

vx_status tivxMemBufferAlloc(tivx_shared_mem_ptr_t *mem_ptr, uint32_t size, vx_enum mem_heap_region);

vx_status tivxMemBufferFree(tivx_shared_mem_ptr_t *mem_ptr, uint32_t size);

vx_status tivxMemBufferMap(void *host_ptr, uint32_t size, vx_enum mem_type, vx_enum maptype);

vx_status tivxMemBufferUnmap(void *host_ptr, uint32_t size, vx_enum mem_type, vx_enum maptype);

uint64_t tivxMemHost2SharedPtr(uint64_t host_ptr, vx_enum mem_heap_region);

void* tivxMemShared2TargetPtr(const tivx_shared_mem_ptr_t *shared_ptr);

uint64_t tivxMemShared2PhysPtr(uint64_t shared_ptr, vx_enum mem_heap_region);

void *tivxMemAlloc(vx_uint32 size, vx_enum mem_heap_region);

vx_status tivxMemFree(void *ptr, vx_uint32 size, vx_enum mem_heap_region);

void tivxMemStats(tivx_mem_stats *stats, vx_enum mem_type);

int32_t tivxMemResetScratchHeap(vx_enum mem_heap_region);

vx_status tivxMemTranslateVirtAddr(const void *virtAddr, uint64_t *fd, void **phyAddr);

vx_bool tivxMemCompareFd(uint64_t dmaBufFd1, uint64_t dmaBufFd2, uint32_t size1, uint32_t size2);

vx_status tivxMemTranslateFd(uint64_t dmaBufFd, uint32_t size, void **virtAddr, void **phyAddr);

void tivxEnableL1DandL2CacheWb(void);

#ifdef __cplusplus
}
#endif

#endif