Add libisagbprn

6 files changed, 259 insertions, 9 deletions

diff --git a/include/config.h b/include/config.h
new file mode 100644
index 0000000..563cd91
--- /dev/null
+++ b/include/config.h
@@ -0,0 +1,21 @@
+#ifndef GUARD_CONFIG_H
+#define GUARD_CONFIG_H
+
+// In the Generation 3 games, Asserts were used in various debug builds.
+// Ruby/Sapphire and Emerald do not have these asserts while Fire Red
+// still has them in the ROM. This is because the developers forgot
+// to define NDEBUG before release, however this has been changed as
+// Ruby's actual debug build does not use the AGBPrint features.
+#define NDEBUG
+
+// To enable print debugging, comment out "#define NDEBUG". This allows
+// the various AGBPrint functions to be used. (See include/gba/isagbprint.h).
+// Some emulators support a debug console window: uncomment NoCashGBAPrint()
+// and NoCashGBAPrintf() in libisagbprn.c to use no$gba's own proprietary
+// printing system. Use NoCashGBAPrint() and NoCashGBAPrintf() like you
+// would normally use AGBPrint() and AGBPrintf().
+
+// NOTE: Don't try to enable assert right now as many pointers
+// still exist in defines and WILL likely result in a broken ROM.
+
+#endif // GUARD_CONFIG_H
diff --git a/include/gba/gba.h b/include/gba/gba.h
index 42ae3cd..3493440 100644
--- a/include/gba/gba.h
+++ b/include/gba/gba.h
@@ -7,5 +7,6 @@
 #include "gba/multiboot.h"
 #include "gba/syscall.h"
 #include "gba/macro.h"
+#include "gba/isagbprint.h"
 
 #endif // GUARD_GBA_GBA_H
diff --git a/include/gba/isagbprint.h b/include/gba/isagbprint.h
new file mode 100644
index 0000000..1be3852
--- /dev/null
+++ b/include/gba/isagbprint.h
@@ -0,0 +1,50 @@
+#ifndef GUARD_GBA_ISAGBPRINT_H
+#define GUARD_GBA_ISAGBPRINT_H
+
+#ifdef NDEBUG
+#define AGBPrintInit()
+#define AGBPutc(cChr)
+#define AGBPrint(pBuf)
+#define AGBPrintf(pBuf, ...)
+#define AGBPrintFlush1Block()
+#define AGBPrintFlush()
+#define AGBAssert(pFile, nLine, pExpression, nStopProgram)
+#else
+void AGBPrintInit(void);
+void AGBPutc(const char cChr);
+void AGBPrint(const char *pBuf);
+void AGBPrintf(const char *pBuf, ...);
+void AGBPrintFlush1Block(void);
+void AGBPrintFlush(void);
+void AGBAssert(const char *pFile, int nLine, const char *pExpression, int nStopProgram);
+#endif
+
+#undef AGB_ASSERT
+#ifdef NDEBUG
+#define AGB_ASSERT(exp)
+#else
+#define AGB_ASSERT(exp) (exp) ? ((void*)0) : AGBAssert(__FILE__, __LINE__, #exp, 1);
+#endif
+
+#undef AGB_WARNING
+#ifdef NDEBUG
+#define AGB_WARNING(exp)
+#else
+#define AGB_WARNING(exp) (exp) ? ((void*)0) : AGBAssert(__FILE__, __LINE__, #exp, 0);
+#endif
+
+// for matching purposes
+
+#ifdef NDEBUG
+#define    AGB_ASSERT_EX(exp, file, line)
+#else
+#define    AGB_ASSERT_EX(exp, file, line) (exp) ? ((void*)0) : AGBAssert(file, line, #exp, 1);
+#endif
+
+#ifdef NDEBUG
+#define    AGB_WARNING_EX(exp, file, line)
+#else
+#define    AGB_WARNING_EX(exp, file, line) (exp) ? ((void*)0) : AGBAssert(file, line, #exp, 0);
+#endif
+
+#endif // GUARD_GBA_ISAGBPRINT_H
diff --git a/include/global.h b/include/global.h
index b5a4593..b991d34 100644
--- a/include/global.h
+++ b/include/global.h
@@ -2,6 +2,7 @@
 #define GUARD_GLOBAL_H
 
 #include <string.h>
+#include "config.h" // We need to define config before gba headers as print stuff needs the functions nulled before defines.
 #include "gba/gba.h"
 
 // IDE support
diff --git a/src/libisagbprn.c b/src/libisagbprn.c
new file mode 100644
index 0000000..e0e979e
--- /dev/null
+++ b/src/libisagbprn.c
@@ -0,0 +1,177 @@
+#include <stdarg.h>
+#include <stdio.h>
+#include "gba/gba.h"
+#include "config.h"
+
+#define AGB_PRINT_FLUSH_ADDR 0x9FE209D
+#define AGB_PRINT_STRUCT_ADDR 0x9FE20F8
+#define AGB_PRINT_PROTECT_ADDR 0x9FE2FFE
+#define WSCNT_DATA (WAITCNT_PHI_OUT_16MHZ | WAITCNT_WS0_S_2 | WAITCNT_WS0_N_4)
+
+// originally for auto no$gba support, the string "no$gba" should be at this address,
+// the user needs to read this string out as the memory viewer won't show it.
+#define NOCASHGBAIDADDR 0x4FFFA00
+#define NOCASHGBAPRINTADDR1 0x4FFFA10 // automatically adds a newline after the string has finished
+#define NOCASHGBAPRINTADDR2 0x4FFFA14 // does not automatically add the newline. by default, NOCASHGBAPRINTADDR2 is used. this is used to keep strings consistent between no$gba and VBA-RR, but a user can choose to forgo this.
+
+struct AGBPrintStruct
+{
+    u16 m_nRequest;
+    u16 m_nBank;
+    u16 m_nGet;
+    u16 m_nPut;
+};
+
+typedef void (*LPFN_PRINT_FLUSH)(void);
+
+#ifndef NDEBUG
+
+void AGBPrintFlush1Block(void);
+
+void AGBPrintInit(void)
+{
+    volatile struct AGBPrintStruct *pPrint = (struct AGBPrintStruct *)AGB_PRINT_STRUCT_ADDR;
+    u16 *pWSCNT = (u16 *)REG_ADDR_WAITCNT;
+    u16 *pProtect = (u16 *)AGB_PRINT_PROTECT_ADDR;
+    u16 nOldWSCNT = *pWSCNT;
+    *pWSCNT = WSCNT_DATA;
+    *pProtect = 0x20;
+    pPrint->m_nRequest = pPrint->m_nGet = pPrint->m_nPut = 0;
+    pPrint->m_nBank = 0xFD;
+    *pProtect = 0;
+    *pWSCNT = nOldWSCNT;
+}
+
+static void AGBPutcInternal(const char cChr)
+{
+    volatile struct AGBPrintStruct *pPrint = (struct AGBPrintStruct *)AGB_PRINT_STRUCT_ADDR;
+    u16 *pPrintBuf = (u16 *)(0x8000000 + (pPrint->m_nBank << 16));
+    u16 *pProtect = (u16 *)AGB_PRINT_PROTECT_ADDR;
+    u16 nData = pPrintBuf[pPrint->m_nPut / 2];
+    *pProtect = 0x20;
+    nData = (pPrint->m_nPut & 1) ? (nData & 0xFF) | (cChr << 8) : (nData & 0xFF00) | cChr;
+    pPrintBuf[pPrint->m_nPut / 2] = nData;
+    pPrint->m_nPut++;
+    *pProtect = 0;
+}
+
+void AGBPutc(const char cChr)
+{
+    u16 *pWSCNT = (u16 *)REG_ADDR_WAITCNT;
+    u16 nOldWSCNT = *pWSCNT;
+    volatile struct AGBPrintStruct *pPrint;
+    *pWSCNT = WSCNT_DATA;
+    AGBPutcInternal(cChr);
+    *pWSCNT = nOldWSCNT;
+    pPrint = (struct AGBPrintStruct *)AGB_PRINT_STRUCT_ADDR;
+    if (pPrint->m_nPut == ((pPrint->m_nGet - 1) & 0xFFFF))
+        AGBPrintFlush1Block();
+}
+
+void AGBPrint(const char *pBuf)
+{
+    volatile struct AGBPrintStruct *pPrint = (struct AGBPrintStruct *)AGB_PRINT_STRUCT_ADDR;
+    u16 *pWSCNT = (u16 *)REG_ADDR_WAITCNT;
+    u16 nOldWSCNT = *pWSCNT;
+    *pWSCNT = WSCNT_DATA;
+    while (*pBuf)
+    {
+        AGBPutc(*pBuf);
+        pBuf++;
+    }
+    *pWSCNT = nOldWSCNT;
+}
+
+void AGBPrintf(const char *pBuf, ...)
+{
+    char bufPrint[0x100];
+    va_list vArgv;
+    va_start(vArgv, pBuf);
+    vsprintf(bufPrint, pBuf, vArgv);
+    va_end(vArgv);
+    AGBPrint(bufPrint);
+}
+
+static void AGBPrintTransferDataInternal(u32 bAllData)
+{
+    LPFN_PRINT_FLUSH lpfnFuncFlush;
+    u16 *pIME;
+    u16 nIME;
+    u16 *pWSCNT;
+    u16 nOldWSCNT;
+    u16 *pProtect;
+    volatile struct AGBPrintStruct *pPrint;
+
+    pProtect = (u16 *)AGB_PRINT_PROTECT_ADDR;
+    pPrint = (struct AGBPrintStruct *)AGB_PRINT_STRUCT_ADDR;
+    lpfnFuncFlush = (LPFN_PRINT_FLUSH)AGB_PRINT_FLUSH_ADDR;
+    pIME = (u16 *)REG_ADDR_IME;
+    nIME = *pIME;
+    pWSCNT = (u16 *)REG_ADDR_WAITCNT;
+    nOldWSCNT = *pWSCNT;
+    *pIME = nIME & ~1;
+    *pWSCNT = WSCNT_DATA;
+
+    if (bAllData)
+    {
+        while (pPrint->m_nPut != pPrint->m_nGet)
+        {
+            *pProtect = 0x20;
+            lpfnFuncFlush();
+            *pProtect = 0;
+        }
+    }
+    else if (pPrint->m_nPut != pPrint->m_nGet)
+    {
+        *pProtect = 0x20;
+        lpfnFuncFlush();
+        *pProtect = 0;
+    }
+
+    *pWSCNT = nOldWSCNT;
+    *pIME = nIME;
+}
+
+void AGBPrintFlush1Block(void)
+{
+    AGBPrintTransferDataInternal(FALSE);
+}
+
+void AGBPrintFlush(void)
+{
+    AGBPrintTransferDataInternal(TRUE);
+}
+
+void AGBAssert(const char *pFile, int nLine, const char *pExpression, int nStopProgram)
+{
+    if (nStopProgram)
+    {
+        AGBPrintf("ASSERTION FAILED  FILE=[%s] LINE=[%d]  EXP=[%s] \n", pFile, nLine, pExpression);
+        AGBPrintFlush();
+        asm(".hword 0xEFFF");
+    }
+    else
+    {
+        AGBPrintf("WARING FILE=[%s] LINE=[%d]  EXP=[%s] \n", pFile, nLine, pExpression);
+    }
+}
+
+// no$gba print functions, uncomment to use
+/*
+void NoCashGBAPrint(const char *pBuf)
+{
+    *(volatile u32*)NOCASHGBAPRINTADDR2 = (u32)pBuf;
+}
+
+void NoCashGBAPrintf(const char *pBuf, ...)
+{
+    char bufPrint[0x100];
+    va_list vArgv;
+    va_start(vArgv, pBuf);
+    vsprintf(bufPrint, pBuf, vArgv);
+    va_end(vArgv);
+    NoCashGBAPrint(bufPrint);
+}
+*/
+
+#endif
diff --git a/src/save.c b/src/save.c
index f8da6ce..6478c12 100644
--- a/src/save.c
+++ b/src/save.c
@@ -110,12 +110,12 @@ bool8 ValidateChecksum(u8 *in, u32 size)
 
 void sub_8011CA8(u32 *out, s32 size)
 {
-    // Needed to match
-    if (gUnknown_203B184) {
-        size++;
-        size--;
+    if (gUnknown_203B184 == NULL) {
+        AGB_WARNING("A warning most likely went here.");
+        *out += (size + 0xFFF) / 0x1000;
+    } else {
+        *out += (size + 0xFFF) / 0x1000;
     }
-    *out += (size + 0xFFF) / 0x1000;
 }
 
 u32 WriteSaveSector(s32 *a, u8 *src, s32 size)
@@ -124,7 +124,7 @@ u32 WriteSaveSector(s32 *a, u8 *src, s32 size)
     s32 r6 = *a;
     sub_8011CA8(a, size);
     CalculateChecksum(src, size);
-    if (!gUnknown_203B184) {
+    if (gUnknown_203B184 == NULL) {
         r1 = WriteFlashData(r6, src, size);
     }
     else if (sub_800DAB8()) {
@@ -152,7 +152,7 @@ u32 ReadSaveSector(s32 *a, u8 *dest, s32 size)
     u32 r1;
     s32 r6 = *a;
     sub_8011CA8(a, size);
-    if (!gUnknown_203B184) {
+    if (gUnknown_203B184 == NULL) {
         r1 = ReadFlashData(r6, dest, size);
     }
     else if (sub_800DAB8()) {
@@ -202,7 +202,7 @@ u32 sub_8011DAC(u32 *a)
     }
     if (!r7)
     {
-        if (!gUnknown_203B184) {
+        if (gUnknown_203B184 == NULL) {
             sub_8011C28(r5->unk41C);
             sub_8011C40(r5->unk418);
             SetRngState(r5->unk420);
@@ -215,7 +215,7 @@ u32 sub_8011DAC(u32 *a)
     }
     if (!r7)
     {
-        if (!gUnknown_203B184) {
+        if (gUnknown_203B184 == NULL) {
             if (!sub_8002718(r5->unk004)) {
                 r7 = 4;
             }