OS_Get*ArenaHi


C Specification

#include <nitro/os.h>

void* OS_GetArenaHi( OSArenaId id );

void* OS_GetMainArenaHi( void );
void* OS_GetSubpPrivArenaHi( void );
void* OS_GetMainExArenaHi( void );
void* OS_GetITCMArenaHi( void );
void* OS_GetDTCMArenaHi( void );
void* OS_GetSharedArenaHi( void );
void* OS_GetWramMainArenaHi( void );
void* OS_GetWramSubArenaHi( void );
void* OS_GetWramSubPrivArenaHi( void );

Description

Acquires the address of the upper boundary of the specified arena.

id specifies an arena using an arena ID. For details on arena ID see OS_InitArena().

OS_GetMainArenaHi is the inline function for OS_GetArenaHi( OS_ARENA_MAIN ).
OS_GetSubPrivArenaHi is the inline function for OS_GetArenaHi( OS_ARENA_MAIN_SUBPRIV ).
OS_GetMainExArenaHi is the inline function for OS_GetArenaHi( OS_ARENA_MAINEX ).
OS_GetITCMArenaHi is the inline function for OS_GetArenaHi( OS_ARENA_ITCM ).
OS_GetDTCMArenaHi is the inline function for OS_GetArenaHi( OS_ARENA_DTCM ).
OS_GetSharedArenaHi is the inline function for OS_GetArenaHi( OS_ARENA_SHARED ).
OS_GetWramMainArenaHi is the inline function for OS_GetArenaHi( OS_ARENA_MAIN ).
OS_GetWramSubArenaHi is the inline function for OS_GetArenaHi( OS_ARENA_WRAM_SUB ).
OS_GetWramSubPrivArenaHi is the inline function for OS_GetArenaHi( OS_ARENA_WRAM_SUBPRIV ).

Arguments

id Arena ID

Return Values

Returns the upper boundary address of the specified arena.

See Also

OS_InitArena, OSSetArenaHi, OSGetArenaLo

Revision History

02/19/2004 Changed the number of arenas from 6 to 9
01/16/2004 Added MainEx
01/06/2004 Initial Version