aram.h

Go to the documentation of this file.

/*-------------------------------------------------------------

aram.h -- ARAM subsystem

Copyright (C) 2004
Michael Wiedenbauer (shagkur)
Dave Murphy (WinterMute)

This software is provided 'as-is', without any express or implied
warranty.  In no event will the authors be held liable for any
damages arising from the use of this software.

Permission is granted to anyone to use this software for any
purpose, including commercial applications, and to alter it and
redistribute it freely, subject to the following restrictions:

1.  The origin of this software must not be misrepresented; you
must not claim that you wrote the original software. If you use
this software in a product, an acknowledgment in the product
documentation would be appreciated but is not required.

2.  Altered source versions must be plainly marked as such, and
must not be misrepresented as being the original software.

3.  This notice may not be removed or altered from any source
distribution.

-------------------------------------------------------------*/


#ifndef __ARAM_H__
#define __ARAM_H__

#include <gctypes.h>


#define AR_MRAMTOARAM       0       
#define AR_ARAMTOMRAM       1       
#define AR_ARAMINTALL       0       
#define AR_ARAMINTUSER      1       
#ifdef __cplusplus
   extern "C" {
#endif /* __cplusplus */


typedef void (*ARCallback)(void);


ARCallback AR_RegisterCallback(ARCallback callback);


u32 AR_GetDMAStatus();


u32 AR_Init(u32 *stack_idx_array,u32 num_entries);


void AR_StartDMA(u32 dir,u32 memaddr,u32 aramaddr,u32 len);


u32 AR_Alloc(u32 len);


u32 AR_Free(u32 *len);


void AR_Clear(u32 flag);


BOOL AR_CheckInit();


void AR_Reset();


u32 AR_GetSize();


u32 AR_GetBaseAddress();


u32 AR_GetInternalSize();


#define AR_StartDMARead(maddr,araddr,tlen)  \
    AR_StartDMA(AR_ARAMTOMRAM,maddr,araddr,tlen);


#define AR_StartDMAWrite(maddr,araddr,tlen) \
    AR_StartDMA(AR_MRAMTOARAM,maddr,araddr,tlen);

#ifdef __cplusplus
   }
#endif /* __cplusplus */

#endif //__ARAM_H__