Start overhaul of OS headers

include/Dolphin/OS/OSAlarm.h

@@ -0,0 +1,48 @@
+#ifndef _DOLPHIN_OS_OSALARM_H
+#define _DOLPHIN_OS_OSALARM_H
+
+#include "types.h"
+#include "Dolphin/OS/OSContext.h"
+#include "Dolphin/OS/OSUtil.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif // ifdef __cplusplus
+
+/////////// ALARM TYPES //////////
+typedef struct OSAlarm OSAlarm;
+
+// Generic alarm handler function.
+typedef void (*OSAlarmHandler)(OSAlarm* alarm, OSContext* context);
+
+// Struct for storing alarm information.
+struct OSAlarm {
+	OSAlarmHandler handler; // _00
+	u32 tag;                // _04
+	OSTime fire;            // _08
+	OSAlarm* prev;          // _10
+	OSAlarm* next;          // _14
+	OSTime period;          // _18, period of periodic alarm
+	OSTime start;           // _20, start of periodic alarm
+};
+
+// Alarm functions.
+void OSInitAlarm();
+void OSSetAlarm(OSAlarm* alarm, OSTime tick, OSAlarmHandler handler);
+void OSCreateAlarm(OSAlarm* alarm);
+void OSCancelAlarm(OSAlarm* alarm);
+
+// Unused/inlined in P2.
+BOOL OSCheckAlarmQueue();
+void OSSetAbsAlarm(OSAlarm* alarm, OSTime time, OSAlarmHandler handler);
+void OSSetPeriodicAlarm(OSAlarm* alarm, OSTime start, OSTime period, OSAlarmHandler handler);
+void OSSetAlarmTag(OSAlarm* alarm, u32 tag);
+void OSCancelAlarms(u32 tag);
+
+//////////////////////////////////
+
+#ifdef __cplusplus
+};
+#endif // ifdef __cplusplus
+
+#endif

include/Dolphin/OS/OSContext.h

@@ -0,0 +1,207 @@
+#ifndef _DOLPHIN_OS_OSCONTEXT_H
+#define _DOLPHIN_OS_OSCONTEXT_H
+
+#include "types.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif // ifdef __cplusplus
+
+////////// CONTEXT TYPES /////////
+// Struct for holding register context info (size 0x2C8).
+typedef struct OSContext {
+	u32 gpr[32];   // _00, general purpose registers.
+	u32 cr;        // _80
+	u32 lr;        // _84
+	u32 ctr;       // _88
+	u32 xer;       // _8C
+	f64 fpr[32];   // _90, floating point registers.
+	u32 fpscr_pad; // _190
+	u32 fpscr;     // _194
+	u32 srr0;      // _198, exception handling 0.
+	u32 srr1;      // _19C, exception handling 1.
+	u16 mode;      // _1A0, context mode.
+	u16 state;     // _1A2, |'d OS_CONTEXT_STATE_*
+	u32 gqr[8];    // _1A4, Gekko additional registers.
+	f64 psf[32];   // _1C8, Gekko additional registers.
+} OSContext;
+
+// Size of context frame.
+// NB: size of context + padding for stack frame header.
+#define __OS_CONTEXT_FRAME 768
+
+//////////////////////////////////
+
+/////// CONTEXT FUNCTIONS ////////
+// Context functions.
+void OSLoadContext(OSContext* context);
+void OSClearContext(OSContext* context);
+void OSInitContext(OSContext* context, u32 pc, u32 stackPtr);
+void OSDumpContext(OSContext* context);
+void OSSaveContext(OSContext* context);
+
+u32 OSGetStackPointer();
+
+// Current context functions.
+OSContext* OSGetCurrentContext();
+void OSSetCurrentContext(OSContext* context);
+
+// FPU functions.
+void OSSaveFPUContext(OSContext* context);
+void OSFillFPUContext(OSContext* context);
+void OSSwitchFPUContext(OSContext* context); // unsure of arguments.
+
+// Unused/inlined in P2.
+u32 OSSwitchStack(u32 newStackPtr);
+int OSSwitchFiber(u32 pc, u32 newStackPtr);
+
+void OSLoadFPUContext(OSContext* context);
+
+//////////////////////////////////
+
+//////// REGISTER DEFINES ////////
+// Floating point modes.
+#define OS_CONTEXT_MODE_FPU  (0x01U)
+#define OS_CONTEXT_MODE_PSFP (0x02U)
+
+// Context states.
+#define OS_CONTEXT_STATE_FPSAVED (0x01U)
+#define OS_CONTEXT_STATE_EXC     (0x02U)
+
+// General purpose registers.
+#define OS_CONTEXT_R0  0
+#define OS_CONTEXT_R1  4
+#define OS_CONTEXT_R2  8
+#define OS_CONTEXT_R3  12
+#define OS_CONTEXT_R4  16
+#define OS_CONTEXT_R5  20
+#define OS_CONTEXT_R6  24
+#define OS_CONTEXT_R7  28
+#define OS_CONTEXT_R8  32
+#define OS_CONTEXT_R9  36
+#define OS_CONTEXT_R10 40
+#define OS_CONTEXT_R11 44
+#define OS_CONTEXT_R12 48
+#define OS_CONTEXT_R13 52
+#define OS_CONTEXT_R14 56
+#define OS_CONTEXT_R15 60
+#define OS_CONTEXT_R16 64
+#define OS_CONTEXT_R17 68
+#define OS_CONTEXT_R18 72
+#define OS_CONTEXT_R19 76
+#define OS_CONTEXT_R20 80
+#define OS_CONTEXT_R21 84
+#define OS_CONTEXT_R22 88
+#define OS_CONTEXT_R23 92
+#define OS_CONTEXT_R24 96
+#define OS_CONTEXT_R25 100
+#define OS_CONTEXT_R26 104
+#define OS_CONTEXT_R27 108
+#define OS_CONTEXT_R28 112
+#define OS_CONTEXT_R29 116
+#define OS_CONTEXT_R30 120
+#define OS_CONTEXT_R31 124
+
+// Other registers.
+#define OS_CONTEXT_CR  128
+#define OS_CONTEXT_LR  132
+#define OS_CONTEXT_CTR 136
+#define OS_CONTEXT_XER 140
+
+// Floating point registers.
+#define OS_CONTEXT_FPR0  144
+#define OS_CONTEXT_FPR1  152
+#define OS_CONTEXT_FPR2  160
+#define OS_CONTEXT_FPR3  168
+#define OS_CONTEXT_FPR4  176
+#define OS_CONTEXT_FPR5  184
+#define OS_CONTEXT_FPR6  192
+#define OS_CONTEXT_FPR7  200
+#define OS_CONTEXT_FPR8  208
+#define OS_CONTEXT_FPR9  216
+#define OS_CONTEXT_FPR10 224
+#define OS_CONTEXT_FPR11 232
+#define OS_CONTEXT_FPR12 240
+#define OS_CONTEXT_FPR13 248
+#define OS_CONTEXT_FPR14 256
+#define OS_CONTEXT_FPR15 264
+#define OS_CONTEXT_FPR16 272
+#define OS_CONTEXT_FPR17 280
+#define OS_CONTEXT_FPR18 288
+#define OS_CONTEXT_FPR19 296
+#define OS_CONTEXT_FPR20 304
+#define OS_CONTEXT_FPR21 312
+#define OS_CONTEXT_FPR22 320
+#define OS_CONTEXT_FPR23 328
+#define OS_CONTEXT_FPR24 336
+#define OS_CONTEXT_FPR25 344
+#define OS_CONTEXT_FPR26 352
+#define OS_CONTEXT_FPR27 360
+#define OS_CONTEXT_FPR28 368
+#define OS_CONTEXT_FPR29 376
+#define OS_CONTEXT_FPR30 384
+#define OS_CONTEXT_FPR31 392
+
+// Floating point scratch (0x8 incl. padding)
+#define OS_CONTEXT_FPSCR 400
+
+// Exception handling registers.
+#define OS_CONTEXT_SRR0 408
+#define OS_CONTEXT_SRR1 412
+
+// Context mode registers (0x2 each).
+#define OS_CONTEXT_MODE  416
+#define OS_CONTEXT_STATE 418
+
+// Gekko-specific GQR registers.
+#define OS_CONTEXT_GQR0     420
+#define OS_CONTEXT_GQR1     424
+#define OS_CONTEXT_GQR2     428
+#define OS_CONTEXT_GQR3     432
+#define OS_CONTEXT_GQR4     436
+#define OS_CONTEXT_GQR5     440
+#define OS_CONTEXT_GQR6     444
+#define OS_CONTEXT_GQR7     448
+#define __OSCONTEXT_PADDING 452 // padding for double-word alignment of PSFs.
+
+// Gekko-specific PSF registers.
+#define OS_CONTEXT_PSF0  456
+#define OS_CONTEXT_PSF1  464
+#define OS_CONTEXT_PSF2  472
+#define OS_CONTEXT_PSF3  480
+#define OS_CONTEXT_PSF4  488
+#define OS_CONTEXT_PSF5  496
+#define OS_CONTEXT_PSF6  504
+#define OS_CONTEXT_PSF7  512
+#define OS_CONTEXT_PSF8  520
+#define OS_CONTEXT_PSF9  528
+#define OS_CONTEXT_PSF10 536
+#define OS_CONTEXT_PSF11 544
+#define OS_CONTEXT_PSF12 552
+#define OS_CONTEXT_PSF13 560
+#define OS_CONTEXT_PSF14 568
+#define OS_CONTEXT_PSF15 576
+#define OS_CONTEXT_PSF16 584
+#define OS_CONTEXT_PSF17 592
+#define OS_CONTEXT_PSF18 600
+#define OS_CONTEXT_PSF19 608
+#define OS_CONTEXT_PSF20 616
+#define OS_CONTEXT_PSF21 624
+#define OS_CONTEXT_PSF22 632
+#define OS_CONTEXT_PSF23 640
+#define OS_CONTEXT_PSF24 648
+#define OS_CONTEXT_PSF25 656
+#define OS_CONTEXT_PSF26 664
+#define OS_CONTEXT_PSF27 672
+#define OS_CONTEXT_PSF28 680
+#define OS_CONTEXT_PSF29 688
+#define OS_CONTEXT_PSF30 696
+#define OS_CONTEXT_PSF31 704
+
+//////////////////////////////////
+
+#ifdef __cplusplus
+};
+#endif // ifdef __cplusplus
+
+#endif

include/Dolphin/OS/OSUtil.h

@@ -0,0 +1,74 @@
+#ifndef _DOLPHIN_OS_OSUTIL_H
+#define _DOLPHIN_OS_OSUTIL_H
+
+#include "types.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif // ifdef __cplusplus
+
+///// USEFUL MACROS/DEFINES //////
+// Macro for making clear things are addresses.
+#define AT_ADDRESS(addr) : (addr)
+
+// Defines for cached and uncached memory.
+#define OS_BASE_CACHED   (0x80000000)
+#define OS_BASE_UNCACHED (0xC0000000)
+
+//////////////////////////////////
+
+////////// CLOCK UTILS ///////////
+// Time and tick typedefs for convenience.
+typedef s64 OSTime;
+typedef u32 OSTick;
+
+// Clock speeds.
+u32 __OSBusClock AT_ADDRESS(OS_BASE_CACHED | 0x00F8);
+u32 __OSCoreClock AT_ADDRESS(OS_BASE_CACHED | 0x00FC);
+
+#define OS_BUS_CLOCK   __OSBusClock
+#define OS_CORE_CLOCK  __OSCoreClock
+#define OS_TIMER_CLOCK (OS_BUS_CLOCK / 4)
+
+// Tick conversions.
+#define OSTicksToCycles(ticks)       (((ticks) * ((OS_CORE_CLOCK * 2) / OS_TIMER_CLOCK)) / 2)
+#define OSTicksToSeconds(ticks)      ((ticks) / OS_TIMER_CLOCK)
+#define OSTicksToMilliseconds(ticks) ((ticks) / (OS_TIMER_CLOCK / 1000))
+#define OSTicksToMicroseconds(ticks) (((ticks)*8) / (OS_TIMER_CLOCK / 125000))
+#define OSTicksToNanoseconds(ticks)  (((ticks)*8000) / (OS_TIMER_CLOCK / 125000))
+#define OSSecondsToTicks(sec)        ((sec)*OS_TIMER_CLOCK)
+#define OSMillisecondsToTicks(msec)  ((msec) * (OS_TIMER_CLOCK / 1000))
+#define OSMicrosecondsToTicks(usec)  (((usec) * (OS_TIMER_CLOCK / 125000)) / 8)
+#define OSNanosecondsToTicks(nsec)   (((nsec) * (OS_TIMER_CLOCK / 125000)) / 8000)
+
+#define OSDiffTick(tick1, tick0) ((s32)(tick1) - (s32)(tick0))
+
+// Time-related getters.
+OSTick OSGetTick();
+OSTime OSGetTime();
+
+// Struct for 'calendar time'.
+typedef struct OSCalendarTime {
+	int sec;  // _00, secs after minute
+	int min;  // _04, mins after hour
+	int hour; // _08, hours since midnight
+	int mday; // _0C, day of month
+	int mon;  // _10, month since Jan
+	int year; // _14, years since 0000
+	int wday; // _18, days since Sunday
+	int yday; // _1C, days since Jan 1
+	int msec; // _20, millisecs after sec
+	int usec; // _24, microsecs after millisec
+} OSCalendarTime;
+
+// Calendar time functions.
+OSTime OSCalendarTimeToTicks(OSCalendarTime* timeDate);
+void OSTicksToCalendarTime(OSTime ticks, OSCalendarTime* timeDate);
+
+//////////////////////////////////
+
+#ifdef __cplusplus
+};
+#endif // ifdef __cplusplus
+
+#endif

include/Dolphin/hw_regs.h

@@ -0,0 +1,41 @@
+#ifndef _DOLPHIN_HW_REGS_H
+#define _DOLPHIN_HW_REGS_H
+
+#include "types.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif // ifdef __cplusplus
+
+/////// HARDWARE REGISTERS ///////
+// Video Interface registers.
+vu16 __VIRegs[59] : 0xCC002000;
+
+// Processor Interface registers.
+vu32 __PIRegs[12] : 0xCC003000;
+
+// Memory Interface registers.
+vu16 __MEMRegs[64] : 0xCC004000;
+
+// Digital Signal Processor registers (for audio mixing).
+vu16 __DSPRegs[32] : 0xCC005000;
+
+// DVD Interface registers.
+vu32 __DIRegs[16] : 0xCC006000;
+
+// Serial Interface registers.
+vu32 __SIRegs[64] : 0xCC006400;
+
+// Expansion/External Interface registers.
+vu32 __EXIRegs[16] : 0xCC006800;
+
+// Audio Streaming Interface registers.
+vu32 __AIRegs[8] : 0xCC006C00;
+
+//////////////////////////////////
+
+#ifdef __cplusplus
+};
+#endif // ifdef __cplusplus
+
+#endif