os.h File Reference

#include <dolphin/types.h>
#include <dolphin/os/OSContext.h>
#include <dolphin/os/OSAlarm.h>
#include <dolphin/os/OSAlloc.h>
#include <dolphin/os/OSCache.h>
#include <dolphin/os/OSDC.h>
#include <dolphin/os/OSError.h>
#include <dolphin/os/OSException.h>
#include <dolphin/os/OSFont.h>
#include <dolphin/os/OSIC.h>
#include <dolphin/os/OSInterrupt.h>
#include <dolphin/os/OSL2.h>
#include <dolphin/os/OSLC.h>
#include <dolphin/os/OSMessage.h>
#include <dolphin/os/OSModule.h>
#include <dolphin/os/OSMutex.h>
#include <dolphin/os/OSReboot.h>
#include <dolphin/os/OSReset.h>
#include <dolphin/os/OSResetSW.h>
#include <dolphin/os/OSRtc.h>
#include <dolphin/os/OSSerial.h>
#include <dolphin/os/OSStopwatch.h>
#include <dolphin/os/OSThread.h>
#include <dolphin/os/OSTime.h>
#include <dolphin/dvd.h>

Go to the source code of this file.

Data Structures
struct	OSCalendarTime
struct	OSBootInfo

Macros
#define	OFFSET(addr, align)
#define	ROUND(n, a)
#define	TRUNC(n, a)
#define	OS_CACHED_REGION_PREFIX   0x8000
#define	OS_UNCACHED_REGION_PREFIX   0xC000
#define	OS_PHYSICAL_MASK   0x3FFF
#define	OS_BASE_CACHED   (OS_CACHED_REGION_PREFIX << 16)
#define	OS_BASE_UNCACHED   (OS_UNCACHED_REGION_PREFIX << 16)
#define	__OSBusClock   (*(u32*) (OS_BASE_CACHED | 0x00F8))
#define	__OSCoreClock   (*(u32*) (OS_BASE_CACHED | 0x00FC))
#define	OS_BUS_CLOCK   __OSBusClock
#define	OS_CORE_CLOCK   __OSCoreClock
#define	OS_TIMER_CLOCK   (OS_BUS_CLOCK / 4)
#define	OSTicksToSeconds(ticks)
#define	OSTicksToMilliseconds(ticks)
#define	OSTicksToMicroseconds(ticks)
#define	OSSecondsToTicks(sec)
#define	OSMillisecondsToTicks(msec)
#define	OSNanosecondsToTicks(nsec)
#define	OSMicrosecondsToTicks(usec)
#define	OS_CONSOLE_MASK   0xf0000000
#define	OS_CONSOLE_RETAIL   0x00000000
#define	OS_CONSOLE_DEVELOPMENT   0x10000000
#define	OS_CONSOLE_TDEV   0x20000000
#define	OS_CONSOLE_RETAIL4   0x00000004
#define	OS_CONSOLE_RETAIL3   0x00000003
#define	OS_CONSOLE_RETAIL2   0x00000002
#define	OS_CONSOLE_RETAIL1   0x00000001
#define	OS_CONSOLE_TDEVHW4   0x20000007
#define	OS_CONSOLE_TDEVHW3   0x20000006
#define	OS_CONSOLE_TDEVHW2   0x20000005
#define	OS_CONSOLE_TDEVHW1   0x20000004
#define	OS_CONSOLE_DEVHW4   0x10000007
#define	OS_CONSOLE_DEVHW3   0x10000006
#define	OS_CONSOLE_DEVHW2   0x10000005
#define	OS_CONSOLE_DEVHW1   0x10000004
#define	OS_CONSOLE_MINNOW   0x10000003
#define	OS_CONSOLE_ARTHUR   0x10000002
#define	OS_CONSOLE_PC_EMULATOR   0x10000001
#define	OS_CONSOLE_EMULATOR   0x10000000
#define	OS_SOUND_MODE_MONO   0
#define	OS_SOUND_MODE_STEREO   1
#define	DOLPHIN_ATTRIBUTE_NORETURN
#define	OSRoundUp32B(x)
#define	OSRoundDown32B(x)
#define	OSPhysicalToCached(paddr)
#define	OSPhysicalToUncached(paddr)
#define	OSCachedToPhysical(caddr)
#define	OSUncachedToPhysical(ucaddr)
#define	OSCachedToUncached(caddr)
#define	OSUncachedToCached(ucaddr)

Typedefs
typedef s64	OSTime
typedef u32	OSTick
typedef s16	__OSInterrupt
typedef u32	OSInterruptMask
typedef void(*	__OSInterruptHandler) (__OSInterrupt interrupt, OSContext *context)

Functions
u32	OSGetPhysicalMemSize (void)
u32	OSGetConsoleSimulatedMemSize (void)
unsigned long	OSGetConsoleType (void)
void	OSInit (void)
void *	OSGetArenaHi (void)
void *	OSGetArenaLo (void)
void	OSSetArenaHi (void *)
void	OSSetArenaLo (void *)
void *	OSAllocFromArenaLo (u32 size, u32 align)
void *	OSAllocFromArenaHi (u32 size, u32 align)
void	__OSPSInit ()
u32	__OSGetDIConfig (void)
OSTick	OSGetTick (void)
OSTime	OSGetTime (void)
void	OSTicksToCalendarTime (OSTime ticks, OSCalendarTime *td)
OSTime	OSCalendarTimeToTicks (OSCalendarTime *td)
BOOL	OSEnableInterrupts (void)
BOOL	OSDisableInterrupts (void)
BOOL	OSRestoreInterrupts (BOOL level)
u32	OSGetSoundMode (void)
void	OSSetSoundMode (u32 mode)
void	OSReport (char *,...)
DOLPHIN_ATTRIBUTE_NORETURN void	OSPanic (char *file, int line, char *msg,...)
void *	OSPhysicalToCached (u32 paddr)
void *	OSPhysicalToUncached (u32 paddr)
u32	OSCachedToPhysical (void *caddr)
u32	OSUncachedToPhysical (void *ucaddr)
void *	OSCachedToUncached (void *caddr)
void *	OSUncachedToCached (void *ucaddr)

Macro Definition Documentation

OFFSET

#define OFFSET	(		addr,
			align )

Value:

(((u32) (addr) & ((align) - 1)))

ROUND

#define ROUND	(		n,
			a )

Value:

(((u32) (n) + (a) - 1) & ~((a) - 1))

TRUNC

#define TRUNC	(		n,
			a )

Value:

(((u32) (n)) & ~((a) - 1))

OS_CACHED_REGION_PREFIX

#define OS_CACHED_REGION_PREFIX   0x8000

OS_UNCACHED_REGION_PREFIX

#define OS_UNCACHED_REGION_PREFIX   0xC000

OS_PHYSICAL_MASK

#define OS_PHYSICAL_MASK   0x3FFF

OS_BASE_CACHED

#define OS_BASE_CACHED   (OS_CACHED_REGION_PREFIX << 16)

OS_BASE_UNCACHED

#define OS_BASE_UNCACHED   (OS_UNCACHED_REGION_PREFIX << 16)

__OSBusClock

#define __OSBusClock   (*(u32*) (OS_BASE_CACHED | 0x00F8))

__OSCoreClock

#define __OSCoreClock   (*(u32*) (OS_BASE_CACHED | 0x00FC))

OS_BUS_CLOCK

#define OS_BUS_CLOCK   __OSBusClock

OS_CORE_CLOCK

#define OS_CORE_CLOCK   __OSCoreClock

OS_TIMER_CLOCK

#define OS_TIMER_CLOCK   (OS_BUS_CLOCK / 4)

OSTicksToSeconds

#define OSTicksToSeconds

(

ticks

)

Value:

((ticks) / (OS_TIMER_CLOCK))

OSTicksToMilliseconds

#define OSTicksToMilliseconds

(

ticks

)

Value:

((ticks) / (OS_TIMER_CLOCK / 1000))

OSTicksToMicroseconds

#define OSTicksToMicroseconds

(

ticks

)

Value:

((ticks) * 8 / (OS_TIMER_CLOCK / 125000))

OSSecondsToTicks

#define OSSecondsToTicks

(

sec

)

Value:

((sec) * (OS_TIMER_CLOCK))

OSMillisecondsToTicks

#define OSMillisecondsToTicks

(

msec

)

Value:

((msec) * (OS_TIMER_CLOCK / 1000))

OSNanosecondsToTicks

#define OSNanosecondsToTicks

(

nsec

)

Value:

(((nsec) * (OS_TIMER_CLOCK / 125000)) / 8000)

OSMicrosecondsToTicks

#define OSMicrosecondsToTicks

(

usec

)

Value:

(((usec) * (OS_TIMER_CLOCK / 125000)) / 8)

OS_CONSOLE_MASK

#define OS_CONSOLE_MASK   0xf0000000

OS_CONSOLE_RETAIL

#define OS_CONSOLE_RETAIL   0x00000000

OS_CONSOLE_DEVELOPMENT

#define OS_CONSOLE_DEVELOPMENT   0x10000000

OS_CONSOLE_TDEV

#define OS_CONSOLE_TDEV   0x20000000

OS_CONSOLE_RETAIL4

#define OS_CONSOLE_RETAIL4   0x00000004

OS_CONSOLE_RETAIL3

#define OS_CONSOLE_RETAIL3   0x00000003

OS_CONSOLE_RETAIL2

#define OS_CONSOLE_RETAIL2   0x00000002

OS_CONSOLE_RETAIL1

#define OS_CONSOLE_RETAIL1   0x00000001

OS_CONSOLE_TDEVHW4

#define OS_CONSOLE_TDEVHW4   0x20000007

OS_CONSOLE_TDEVHW3

#define OS_CONSOLE_TDEVHW3   0x20000006

OS_CONSOLE_TDEVHW2

#define OS_CONSOLE_TDEVHW2   0x20000005

OS_CONSOLE_TDEVHW1

#define OS_CONSOLE_TDEVHW1   0x20000004

OS_CONSOLE_DEVHW4

#define OS_CONSOLE_DEVHW4   0x10000007

OS_CONSOLE_DEVHW3

#define OS_CONSOLE_DEVHW3   0x10000006

OS_CONSOLE_DEVHW2

#define OS_CONSOLE_DEVHW2   0x10000005

OS_CONSOLE_DEVHW1

#define OS_CONSOLE_DEVHW1   0x10000004

OS_CONSOLE_MINNOW

#define OS_CONSOLE_MINNOW   0x10000003

OS_CONSOLE_ARTHUR

#define OS_CONSOLE_ARTHUR   0x10000002

OS_CONSOLE_PC_EMULATOR

#define OS_CONSOLE_PC_EMULATOR   0x10000001

OS_CONSOLE_EMULATOR

#define OS_CONSOLE_EMULATOR   0x10000000

OS_SOUND_MODE_MONO

#define OS_SOUND_MODE_MONO   0

OS_SOUND_MODE_STEREO

#define OS_SOUND_MODE_STEREO   1

DOLPHIN_ATTRIBUTE_NORETURN

#define DOLPHIN_ATTRIBUTE_NORETURN

OSRoundUp32B

#define OSRoundUp32B

(

x

)

Value:

(((u32) (x) + 32 - 1) & ~(32 - 1))

OSRoundDown32B

#define OSRoundDown32B

(

x

)

Value:

(((u32) (x)) & ~(32 - 1))

OSPhysicalToCached

#define OSPhysicalToCached

(

paddr

)

Value:

((void*) ((u32) (OS_BASE_CACHED + (u32) (paddr))))

OSPhysicalToUncached

#define OSPhysicalToUncached

(

paddr

)

Value:

((void*) ((u32) (OS_BASE_UNCACHED + (u32) (paddr))))

OSCachedToPhysical

#define OSCachedToPhysical

(

caddr

)

Value:

((u32) ((u32) (caddr) - OS_BASE_CACHED))

OSUncachedToPhysical

#define OSUncachedToPhysical

(

ucaddr

)

Value:

((u32) ((u32) (ucaddr) - OS_BASE_UNCACHED))

OSCachedToUncached

#define OSCachedToUncached

(

caddr

)

Value:

((void*) ((u8*) (caddr) + (OS_BASE_UNCACHED - OS_BASE_CACHED)))

OSUncachedToCached

#define OSUncachedToCached

(

ucaddr

)

Value:

((void*) ((u8*) (ucaddr) - (OS_BASE_UNCACHED - OS_BASE_CACHED)))

Typedef Documentation

OSTime

typedef s64 OSTime

OSTick

typedef u32 OSTick

__OSInterrupt

typedef s16 __OSInterrupt

OSInterruptMask

typedef u32 OSInterruptMask

__OSInterruptHandler

typedef void(* __OSInterruptHandler) (__OSInterrupt interrupt, OSContext *context)

Function Documentation

OSGetPhysicalMemSize()

u32 OSGetPhysicalMemSize

(

void

)

OSGetConsoleSimulatedMemSize()

u32 OSGetConsoleSimulatedMemSize

(

void

)

OSGetConsoleType()

unsigned long OSGetConsoleType

(

void

)

OSInit()

void OSInit

(

void

)

OSGetArenaHi()

void * OSGetArenaHi

(

void

)

OSGetArenaLo()

void * OSGetArenaLo

(

void

)

OSSetArenaHi()

void OSSetArenaHi

(

void *

)

OSSetArenaLo()

void OSSetArenaLo

(

void *

)

OSAllocFromArenaLo()

void * OSAllocFromArenaLo	(	u32	size,
		u32	align )

OSAllocFromArenaHi()

void * OSAllocFromArenaHi	(	u32	size,
		u32	align )

__OSPSInit()

void __OSPSInit

(

)

__OSGetDIConfig()

u32 __OSGetDIConfig

(

void

)

OSGetTick()

OSTick OSGetTick

(

void

)

OSGetTime()

OSTime OSGetTime

(

void

)

OSTicksToCalendarTime()

void OSTicksToCalendarTime	(	OSTime	ticks,
		OSCalendarTime *	td )

OSCalendarTimeToTicks()

OSTime OSCalendarTimeToTicks

(

OSCalendarTime *

td

)

OSEnableInterrupts()

BOOL OSEnableInterrupts

(

void

)

OSDisableInterrupts()

BOOL OSDisableInterrupts

(

void

)

OSRestoreInterrupts()

BOOL OSRestoreInterrupts

(

BOOL

level

)

OSGetSoundMode()

u32 OSGetSoundMode

(

void

)

OSSetSoundMode()

void OSSetSoundMode

(

u32

mode

)

OSReport()

void OSReport	(	char *	,
			... )

OSPanic()

DOLPHIN_ATTRIBUTE_NORETURN void OSPanic	(	char *	file,
		int	line,
		char *	msg,
			... )

OSPhysicalToCached()

void * OSPhysicalToCached

(

u32

paddr

)

OSPhysicalToUncached()

void * OSPhysicalToUncached

(

u32

paddr

)

OSCachedToPhysical()

u32 OSCachedToPhysical

(

void *

caddr

)

OSUncachedToPhysical()

u32 OSUncachedToPhysical

(

void *

ucaddr

)

OSCachedToUncached()

void * OSCachedToUncached

(

void *

caddr

)

OSUncachedToCached()

void * OSUncachedToCached

(

void *

ucaddr

)