libOGC  1.0
 All Data Structures Files Functions Variables Typedefs Macros Modules Pages
Typedefs | Functions
arqmgr.h File Reference

ARAM queue managemnt subsystem. More...

#include <gctypes.h>

Typedefs

typedef void(* ARQMCallback )(s32 result)
 function pointer typedef for the user's callback when ARAM operation has completed More...
 

Functions

u32 ARQM_GetFreeSize ()
 Return Returns remaining number of bytes on stack. More...
 
u32 ARQM_GetStackPointer ()
 Return the ARAM address of the next free stack pointer. More...
 
u32 ARQM_GetZeroBuffer ()
 Returns ARAM address of 'zero buffer'. More...
 
void ARQM_Init (u32 arambase, s32 len)
 Initialize the ARAM queue management system. More...
 
u32 ARQM_PushData (void *buffer, s32 len)
 Push the data onto the ARAM queue. More...
 

Detailed Description

ARAM queue managemnt subsystem.

Typedef Documentation

void(* ARQMCallback)()

function pointer typedef for the user's callback when ARAM operation has completed

Parameters
none

Function Documentation

u32 ARQM_GetFreeSize ( )

Return Returns remaining number of bytes on stack.

Returns
See description
u32 ARQM_GetStackPointer ( )

Return the ARAM address of the next free stack pointer.

Returns
See description
u32 ARQM_GetZeroBuffer ( )

Returns ARAM address of 'zero buffer'.

Returns
See description
void ARQM_Init ( u32  arambase,
s32  len 
)

Initialize the ARAM queue management system.

Parameters
[in]arambaseARAM startaddress to take for the queue stack
[in]lenmaximum amount of memory to be reserved from the ARAM for the queue management
Returns
none
u32 ARQM_PushData ( void *  buff,
s32  len 
)

Push the data onto the ARAM queue.

Parameters
[in]buffstartaddress of buffer to be pushed onto the queue. NOTE: Must be 32-bytealigned.
[in]lenlength of data to be pushed onto the queue.
Returns
none