Memory.h

Go to the documentation of this file.

/* 
 * Copyright (c) 2009, 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


/*
 *  ======== Memory_DEFAULTALIGNMENT ========
 */
#define Memory_DEFAULTALIGNMENT ((UInt)(-1))

/*
 *  ======== Memory_GTNAME ========
 */
#define Memory_GTNAME "OM"

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

typedef enum {
    Memory_MALLOC = 0,        
    Memory_SEG = 1,           
    Memory_CONTIGPOOL = 2,    
    Memory_CONTIGHEAP =3      
} Memory_type;

typedef struct Memory_AllocParams {
    Memory_type type;   
    UInt flags;         
    UInt align;         
    UInt seg;           
} Memory_AllocParams;


#define Memory_CACHED           0x00000000  
#define Memory_NONCACHED        0x00000001  
#define Memory_CACHEDMASK       0x00000001  
extern Memory_AllocParams Memory_DEFAULTPARAMS;

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

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


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


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


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


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


/*
 *  ======== Memory_contigStat ========
 */
extern Bool Memory_contigStat(Memory_Stat *statbuf);

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


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


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

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

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


#ifdef ti_sdo_ce_osal_Memory_USEDEPRECATEDAPIS

/*
 *  ======== Memory_getPhysicalAddress ========
 *  Convert user virtual address to physical address
 *  (returns the exact same value everywhere other than on Linux)
 *
 *  This function is deprecated -- everyone should be calling 
 *  Memory_getBufferPhysicalAddress() instead.
 */
static inline UInt32 Memory_getPhysicalAddress(Ptr virtualAddress)
{
    return(Memory_getBufferPhysicalAddress(virtualAddress, 4, NULL));
}

#endif

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

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


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


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

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

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

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


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


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

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

  /* ingroup */

#ifdef __cplusplus
}
#endif

#endif
/*
 *  @(#) ti.sdo.ce.osal; 2, 0, 2,384; 12-18-2009 17:43:18; /db/atree/library/trees/ce/ce-o06x/src/
 */