arqmgr.h File Reference

ARAM queue management subsystem. More...

#include <gctypes.h>

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

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

Detailed Description

ARAM queue management subsystem.

Typedef Documentation

ARQMCallback

void(* ARQMCallback)(s32 result)

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

Parameters

[in]

result

The result of the ARAM operation.

Function Documentation

ARQM_GetFreeSize()

u32 ARQM_GetFreeSize

(

void

)

Return Returns remaining number of bytes on stack.

Returns

See description

ARQM_GetStackPointer()

u32 ARQM_GetStackPointer

(

void

)

Return the ARAM address of the next free stack pointer.

Returns

See description

ARQM_GetZeroBuffer()

u32 ARQM_GetZeroBuffer

(

void

)

Returns ARAM address of 'zero buffer'.

Returns

See description

ARQM_Init()

void ARQM_Init	(	u32	arambase,
		s32	len
	)

Initialize the ARAM queue management system.

Parameters

[in]	arambase	ARAM startaddress to take for the queue stack
[in]	len	maximum amount of memory to be reserved from the ARAM for the queue management

Returns

none

ARQM_PushData()

u32 ARQM_PushData	(	void *	buffer,
		s32	len
	)

Push the data onto the ARAM queue.

Parameters

[in]	buffer	starting address of a buffer to be pushed onto the queue. NOTE: Must be 32 byte aligned.
[in]	len	length of data to be pushed onto the queue.

Returns

The ARAM starting address for the pushed data.