packages/ti/sdo/ce/osal/Memory.h

Go to the documentation of this file.

/* 
 * Copyright (c) 2012, 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.
 * 
 */
/*
 *  ======== Memory.h ========
 */
#ifndef ti_sdo_ce_osal_Memory_
#define ti_sdo_ce_osal_Memory_

#ifdef __cplusplus
extern "C" {
#endif


#define ti_sdo_ce_osal_Memory_DEFAULTALIGNMENT ((UInt)(-1))

#define Memory_MODNAME "ti.sdo.ce.osal.Memory"

#define ti_sdo_ce_osal_Memory_GTNAME "OM"

typedef struct ti_sdo_ce_osal_Memory_Stat {
    String name;     
    Uint32 base;     
    UInt size;       
    UInt used;       
    UInt length;     
} ti_sdo_ce_osal_Memory_Stat;

typedef enum {
    ti_sdo_ce_osal_Memory_MALLOC = 0,   
    ti_sdo_ce_osal_Memory_SEG = 1,      
    ti_sdo_ce_osal_Memory_CONTIGPOOL = 2, 
    ti_sdo_ce_osal_Memory_CONTIGHEAP =3 
} ti_sdo_ce_osal_Memory_type;

typedef struct ti_sdo_ce_osal_Memory_AllocParams {
    ti_sdo_ce_osal_Memory_type type;    
    UInt flags;         
    UInt align;         
    UInt seg;           
} ti_sdo_ce_osal_Memory_AllocParams;


#define ti_sdo_ce_osal_Memory_CACHED    0x00000000

#define ti_sdo_ce_osal_Memory_NONCACHED 0x00000001

#define ti_sdo_ce_osal_Memory_CACHEDMASK 0x00000001

extern ti_sdo_ce_osal_Memory_AllocParams ti_sdo_ce_osal_Memory_DEFAULTPARAMS;

/*
 *  ======== Memory_alloc ========
 */
extern Ptr ti_sdo_ce_osal_Memory_alloc(UInt size,
        ti_sdo_ce_osal_Memory_AllocParams *params);

/*
 *  ======== Memory_cacheInv ========
 */
extern Void ti_sdo_ce_osal_Memory_cacheInv(Ptr addr, Int sizeInBytes);


/*
 *  ======== Memory_cacheWb ========
 */
extern Void ti_sdo_ce_osal_Memory_cacheWb(Ptr addr, Int sizeInBytes);


/*
 *  ======== Memory_cacheWbInv ========
 */
extern Void ti_sdo_ce_osal_Memory_cacheWbInv(Ptr addr, Int sizeInBytes);


/*
 *  ======== Memory_cacheWbInvAll ========
 */
extern Void ti_sdo_ce_osal_Memory_cacheWbInvAll();


/*
 *  ======== Memory_contigAlloc ========
 */
extern Ptr ti_sdo_ce_osal_Memory_contigAlloc(UInt size, UInt align);


/*
 *  ======== Memory_contigFree ========
 */
extern Bool ti_sdo_ce_osal_Memory_contigFree(Ptr addr, UInt size);


/*
 *  ======== Memory_contigStat ========
 */
extern Bool ti_sdo_ce_osal_Memory_contigStat(ti_sdo_ce_osal_Memory_Stat *stat);

/*
 *  ======== Memory_free ========
 */
extern Bool ti_sdo_ce_osal_Memory_free(Ptr addr, UInt size,
        ti_sdo_ce_osal_Memory_AllocParams *params);


/*
 *  ======== Memory_dumpKnownContigBufs ========
 */
extern Void ti_sdo_ce_osal_Memory_dumpKnownContigBufsList(Void);


/*
 *  ======== Memory_getBufferPhysicalAddress ========
 */
extern UInt32 ti_sdo_ce_osal_Memory_getBufferPhysicalAddress(Ptr virtualAddress,
    Int sizeInBytes, Bool *isContiguous);

/*
 *  ======== Memory_getHeapId ========
 */
extern Int ti_sdo_ce_osal_Memory_getHeapId(String name);

/*
 *  ======== Memory_getNumHeaps ========
 */
extern Int ti_sdo_ce_osal_Memory_getNumHeaps();


/*
 *  ======== Memory_getBufferVirtualAddress ========
 */
extern Ptr ti_sdo_ce_osal_Memory_getBufferVirtualAddress(UInt32 physicalAddress,
    Int sizeInBytes);

/*
 *  ======== Memory_init ========
 */
extern Bool ti_sdo_ce_osal_Memory_init(Void);


/*
 *  ======== Memory_exit ========
 */
extern Void ti_sdo_ce_osal_Memory_exit(Void);


/*
 *  ======== Memory_registerContigBuf ========
 */
extern Void ti_sdo_ce_osal_Memory_registerContigBuf(UInt32 virtualAddress,
        UInt32 sizeInBytes, UInt32 physicalAddress);

#define Memory_redefine ti_sdo_ce_osal_Memory_redefine
/*
 *  ======== Memory_redefine ========
 */
extern Bool ti_sdo_ce_osal_Memory_redefine(Int segId, Uint32 base, Uint32 size);

/*
 *  ======== Memory_restoreHeap ========
 */
extern Bool ti_sdo_ce_osal_Memory_restoreHeap(Int segId);

/*
 *  ======== Memory_segAlloc ========
 */
extern Ptr ti_sdo_ce_osal_Memory_segAlloc(Int segId, UInt size, UInt align);


/*
 *  ======== Memory_segFree ========
 */
extern Bool ti_sdo_ce_osal_Memory_segFree(Int segId, Ptr addr, UInt size);


/*
 *  ======== Memory_segStat ========
 */
extern Bool ti_sdo_ce_osal_Memory_segStat(Int segId,
        ti_sdo_ce_osal_Memory_Stat *statbuf);

/*
 *  ======== Memory_unregisterContigBuf ========
 */
extern Void ti_sdo_ce_osal_Memory_unregisterContigBuf(UInt32 virtualAddress,
    UInt32 sizeInBytes);

/*
 * ======== PREFIX ALIASES ========
 * Same strategy as XDC uses
 */
#if !defined(__nested__) && !defined(ti_sdo_ce_osal_Memory__nolocalnames)

/* module prefix */
#define Memory_DEFAULTALIGNMENT ti_sdo_ce_osal_Memory_DEFAULTALIGNMENT
#define Memory_GTNAME ti_sdo_ce_osal_Memory_GTNAME
#define Memory_Stat ti_sdo_ce_osal_Memory_Stat
#define Memory_type ti_sdo_ce_osal_Memory_type
#define Memory_MALLOC ti_sdo_ce_osal_Memory_MALLOC
#define Memory_SEG ti_sdo_ce_osal_Memory_SEG
#define Memory_CONTIGPOOL ti_sdo_ce_osal_Memory_CONTIGPOOL
#define Memory_CONTIGHEAP ti_sdo_ce_osal_Memory_CONTIGHEAP
#define Memory_AllocParams ti_sdo_ce_osal_Memory_AllocParams
#define Memory_CACHED ti_sdo_ce_osal_Memory_CACHED
#define Memory_NONCACHED ti_sdo_ce_osal_Memory_NONCACHED
#define Memory_CACHEDMASK ti_sdo_ce_osal_Memory_CACHEDMASK
#define Memory_DEFAULTPARAMS ti_sdo_ce_osal_Memory_DEFAULTPARAMS

#define Memory_alloc ti_sdo_ce_osal_Memory_alloc
#define Memory_cacheInv ti_sdo_ce_osal_Memory_cacheInv
#define Memory_cacheWb ti_sdo_ce_osal_Memory_cacheWb
#define Memory_cacheWbInv ti_sdo_ce_osal_Memory_cacheWbInv
#define Memory_cacheWbInvAll ti_sdo_ce_osal_Memory_cacheWbInvAll
#define Memory_contigAlloc ti_sdo_ce_osal_Memory_contigAlloc
#define Memory_contigFree ti_sdo_ce_osal_Memory_contigFree
#define Memory_free ti_sdo_ce_osal_Memory_free
#define Memory_getBufferPhysicalAddress ti_sdo_ce_osal_Memory_getBufferPhysicalAddress
#define Memory_getBufferVirtualAddress ti_sdo_ce_osal_Memory_getBufferVirtualAddress
#define Memory_getHeapId ti_sdo_ce_osal_Memory_getHeapId
#define Memory_getNumHeaps ti_sdo_ce_osal_Memory_getNumHeaps
#define Memory_init ti_sdo_ce_osal_Memory_init
#define Memory_exit ti_sdo_ce_osal_Memory_exit
#define Memory_redefine ti_sdo_ce_osal_Memory_redefine
#define Memory_restoreHeap ti_sdo_ce_osal_Memory_restoreHeap
#define Memory_segAlloc ti_sdo_ce_osal_Memory_segAlloc
#define Memory_segFree ti_sdo_ce_osal_Memory_segFree
#define Memory_segStat ti_sdo_ce_osal_Memory_segStat
#endif


#ifdef __cplusplus
}
#endif

#endif
/*
 *  @(#) ti.sdo.ce.osal; 2, 0, 2,1; 1-17-2012 23:15:26; /db/atree/library/trees/ce/ce-t03/src/ xlibrary

 */