Various RAM map documentation and alignment with SA3 (#175)

* Various documentation and alignment with SA3

* Extract input_recorder.c .data section from core.c, as in SA3

* Align multi_sio.c with SA3

* Document parameters of DisplaySprites

* Document centerOffsetX/Y in DisplaySprites

* Only display copyright note

* Split GAME_ and ENGINE_ macros

* Use ENGINE macros in core.c

* Rename game<->engine interface procedures

* Remove searching in /src for header files in genctx.py

* Fix global.h<->config.h dependency in genctx.py

* Only enable Task logging in debug versions

* Fix uses of DEBUG, remove TEST_GFX_POINTERS because current gfx copy implementation already makes it redundant

* Use 64bit as default target in Win SDL

* Align some files with sa1 and sa3

* Align sprite.c and other files closer with sa1 and sa3

* Various documentation

* Some dodumentation and cleanup from SA1 core.c integration

* Rename sa1_leftovers/ -> sa1_sa2_shared/

* Put gEwramHeap into ewram_data section

Author: JaceCear

Makefile

@@ -30,11 +30,11 @@ ifeq ($(PLATFORM),gba)
   PREFIX := arm-none-eabi-
 else ifeq ($(CPU_ARCH),i386)
   ifeq ($(PLATFORM),sdl_win32)
-    TOOLCHAIN := /usr/i686-w64-mingw32/
-    PREFIX := i686-w64-mingw32-
+    TOOLCHAIN := /usr/x86_64-w64-mingw32/
+    PREFIX := x86_64-w64-mingw32-
   else ifeq ($(PLATFORM),win32)
-    TOOLCHAIN := /usr/i686-w64-mingw32/
-    PREFIX := i686-w64-mingw32-
+    TOOLCHAIN := /usr/x86_64-w64-mingw32/
+    PREFIX := x86_64-w64-mingw32-
   endif
 else
   ifneq ($(PLATFORM),sdl)
@@ -90,7 +90,7 @@ TOOLS = $(foreach tool,$(TOOLBASE),tools/$(tool)/$(tool)$(EXE))
 CPPFLAGS ?= -iquote include -D $(GAME_REGION)
 CC1FLAGS ?= -Wimplicit -Wparentheses -Werror
 
-SDL_MINGW_PKG          :=  ext/SDL2-2.30.3/i686-w64-mingw32
+SDL_MINGW_PKG          :=  ext/SDL2-2.30.3/x86_64-w64-mingw32
 SDL_MINGW_INCLUDE      := $(SDL_MINGW_PKG)/include/SDL2
 SDL_MINGW_BIN          := $(SDL_MINGW_PKG)/bin
 SDL_MINGW_SDL_DLL      := $(SDL_MINGW_PKG)/bin/SDL2.dll
@@ -146,6 +146,7 @@ ifeq ($(DEBUG),1)
   CPPFLAGS += -D DEBUG=1
 else
   CC1FLAGS += -O2
+  CPPFLAGS += -D DEBUG=0
 endif
 
 ifeq ($(PORTABLE),1)
@@ -435,7 +436,7 @@ ifeq ($(PLATFORM),sdl)
 else ifeq ($(PLATFORM),sdl_win32)
 	@cd $(OBJ_DIR) && $(CC1) -mwin32 $(OBJS_REL) -lmingw32 -L$(ROOT_DIR)/$(SDL_MINGW_LIB) -lSDL2main -lSDL2.dll -lwinmm -lkernel32 -lxinput -o $(ROOT_DIR)/$@ -Xlinker -Map "$(ROOT_DIR)/$(MAP)"
 else
-	@cd $(OBJ_DIR) && $(CC1) -mwin32 $(OBJS_REL) -L$(ROOT_DIR)/libagbsyscall -lagbsyscall -lkernel32 -o $(ROOT_DIR)/$@ -Xlinker -Map "$(ROOT_DIR)/$(MAP)"
+	@cd $(OBJ_DIR) && $(CC1) -mwin32 $(OBJS_REL) -L$(ROOT_DIR)/libagbsyscall -lagbsyscall -lkernel32 -lgdi32 -o $(ROOT_DIR)/$@ -Xlinker -Map "$(ROOT_DIR)/$(MAP)"
 endif
 endif
 
@@ -446,7 +447,7 @@ ifeq ($(PLATFORM),gba)
 else ifeq ($(PLATFORM),sdl)
 	cp $< $@
 else
-	$(OBJCOPY) -O pei-i386 $< $@
+	$(OBJCOPY) -O pei-x86-64 $< $@
 ifeq ($(CREATE_PDB),1)
 	$(CV2PDB) $@
 endif

asm/macros/c_decl.inc

@@ -1,10 +1,9 @@
-
 // NOTE:
 // For this to work, the file that is including this file HAS to be passed through the C preprocessor before assembling!
 
 // 32bit Windows and MacOS versions prefix labels using an underscore.
 // For interoperability we need to replicate that behavior here.
-#if ( (CPU_ARCH_X86 && defined(__WIN32)) || defined(__APPLE__) )
+#if ( (CPU_ARCH_X86 && defined(_WIN32) && !defined(_WIN64)) || defined(__APPLE__) )
     #define C_DECL(label) _##label
 #else
     #define C_DECL(label) label

…game/sa1_leftovers/coll__sub_800C4FC.inc …ame/sa1_sa2_shared/coll__sub_800C4FC.incasm/non_matching/game/sa1_leftovers/coll__sub_800C4FC.inc renamed to asm/non_matching/game/sa1_sa2_shared/coll__sub_800C4FC.inc asm/non_matching/game/sa1_leftovers/coll__sub_800C4FC.inc renamed to asm/non_matching/game/sa1_sa2_shared/coll__sub_800C4FC.inc

@@ -25,28 +25,32 @@
 def search_directories(*patterns):
     return it.chain.from_iterable(glob.iglob(pattern,recursive=True) for pattern in patterns)
 
-for filename in search_directories('./src/**/*.h', './include/**/*.h'):
+for filename in search_directories('./include/**/*.h'):
     with open(filename) as header:
         header_name = "/".join(filename.split('/')[2:])
-        
-        # not needed for decomp work
-        if header_name.startswith("platform"):
-            continue
 
         if not header_name in depends_on:            
             depends_on[header_name] = set()
-            if not header_name.startswith("gba/") and header_name != "global.h" and header_name != "functions.h":
-                depends_on[header_name].add("global.h")
-            
-            if header_name.startswith("gba/") and not header_name.endswith("types.h") and not header_name.endswith("defines.h"):
-                depends_on[header_name].add("gba/types.h")
+
+            if not header_name.startswith("gba/"):
+                if header_name != "global.h"      \
+                and header_name != "config.h"     \
+                and header_name != "functions.h":
+                    depends_on[header_name].add("global.h")
 
-            if header_name.startswith("gba/") and not header_name.endswith("multiboot.h") and not header_name.endswith("types.h"):
-                depends_on[header_name].add("gba/multiboot.h")
+            else: # header_name.startswith("gba/")
+                if  not header_name.endswith("types.h") \
+                and not header_name.endswith("defines.h"):
+                    depends_on[header_name].add("gba/types.h")
+                elif not header_name.endswith("multiboot.h") \
+                and not header_name.endswith("types.h"):
+                    depends_on[header_name].add("gba/multiboot.h")
 
         data[header_name] = ""
         for line in header.readlines():
-            if "#include" in line and not line.startswith("//") and '<' not in line:
+            if "#include" in line         \
+            and not line.startswith("//") \
+            and '<' not in line:
                 requires = line.split('"')[1]
                 depends_on[header_name].add(requires)
                 continue
@@ -58,7 +62,6 @@ def search_directories(*patterns):
 print_order = tuple(ts.static_order())
 
 with open('ctx.c', 'w') as context:
-    context.write("#define PLATFORM_GBA 1\n")
     for header in print_order:
         exclude = False
         for e in excluded:

…sa1_leftovers/input_buf__sub_800DF8C.inc …a1_sa2_shared/input_buf__sub_800DF8C.incasm/non_matching/game/sa1_leftovers/input_buf__sub_800DF8C.inc renamed to asm/non_matching/game/sa1_sa2_shared/input_buf__sub_800DF8C.inc asm/non_matching/game/sa1_leftovers/input_buf__sub_800DF8C.inc renamed to asm/non_matching/game/sa1_sa2_shared/input_buf__sub_800DF8C.inc

@@ -8,6 +8,4 @@ void UpdateBgAnimationTiles(Background *);
 
 s32 RenderText(void *dest, const void *font, u16 x, u16 y, u8 bg, const char *text, u8 palette);
 
-void numToASCII(u8 digits[5], u16 number);
-
 #endif // GUARD_ANIMATION_COMMANDS_EXTRA_H

…ame/sa1_leftovers/interactables/.gitkeep …me/sa1_sa2_shared/interactables/.gitkeepasm/non_matching/game/sa1_leftovers/interactables/.gitkeep renamed to asm/non_matching/game/sa1_sa2_shared/interactables/.gitkeep asm/non_matching/game/sa1_leftovers/interactables/.gitkeep renamed to asm/non_matching/game/sa1_sa2_shared/interactables/.gitkeep

@@ -3,13 +3,23 @@
 
 /* TODO: Move config.h into a different location? */
 
-#define GAME_SA1 1
-#define GAME_SA2 2
-#define GAME_SA3 3
+#define GAME_SA1   1
+#define GAME_SA2   2
+#define GAME_SA3   3
+#define GAME_KATAM 4
 
-// TODO: Define this in Makefile through a compiler macro!
+#define ENGINE_1 1
+#define ENGINE_2 2
+#define ENGINE_3 3
+#define ENGINE_4 4
+
+// TODO: Define this in Makefile through a compiler macro?
 #define GAME GAME_SA2
 
+// TODO: Do SA1 and SA2 use the same engine ver?
+// TODO: Do SA3 and KATAM use the same engine ver?
+#define ENGINE GAME
+
 // TODO: Put somewhere else?
 #if PLATFORM_GBA
 #define USE_NEW_DMA 0

…ctables/CreatePlatformBreakParticles.inc …ctables/CreatePlatformBreakParticles.incasm/non_matching/game/sa1_leftovers/interactables/CreatePlatformBreakParticles.inc renamed to asm/non_matching/game/sa1_sa2_shared/interactables/CreatePlatformBreakParticles.inc asm/non_matching/game/sa1_leftovers/interactables/CreatePlatformBreakParticles.inc renamed to asm/non_matching/game/sa1_sa2_shared/interactables/CreatePlatformBreakParticles.inc

@@ -224,7 +224,6 @@ extern u8 gNumHBlankCallbacks;
 extern u8 gNumHBlankIntrs;
 
 extern u8 gIwramHeap[0x2204];
-extern u8 gEwramHeap[0x20080];
 
 extern void *gVramHeapStartAddr;
 extern u16 gVramHeapMaxTileSlots;
@@ -273,7 +272,7 @@ extern u16 gUnknown_03001944;
 extern u8 gUnknown_03001948;
 extern u16 gUnknown_0300194C;
 
-extern Tilemap **gTilemapsRef; // TODO: make this an array and add size
+extern Tilemap **gTilemapsRef;
 extern u8 gUnknown_03002280[4][4];
 extern u8 gUnknown_03004D80[16]; // TODO: Is this 4 (# backgrounds), instead of 16?
 
@@ -294,17 +293,6 @@ extern u8 gVramGraphicsCopyQueueIndex;
 
 #define INC_GRAPHICS_QUEUE_CURSOR(cursor) cursor = (cursor + 1) % ARRAY_COUNT(gVramGraphicsCopyQueue);
 
-/* Make sure that both pointers are valid */
-#ifndef DEBUG
-#define TEST_GFX_POINTERS(gfx)
-#else
-#define TEST_GFX_POINTERS(gfx)                                                                                                             \
-    {                                                                                                                                      \
-        volatile u8 testVarDst = *(u8 *)((gfx)->dest);                                                                                     \
-        volatile u8 testVarSrc = *(u8 *)((gfx)->src);                                                                                      \
-    }
-#endif
-
 #if PORTABLE
 // On the GBA we use a fixed heap to allocate memory
 // but on other OS's we malloc and free memory which
@@ -315,15 +303,13 @@ extern u8 gVramGraphicsCopyQueueIndex;
 // has not happened we don't get invalid memory access
 extern struct GraphicsData gVramGraphicsCopyQueueBuffer[32];
 #define ADD_TO_GRAPHICS_QUEUE(gfx)                                                                                                         \
-    TEST_GFX_POINTERS(gfx);                                                                                                                \
     memcpy(&gVramGraphicsCopyQueueBuffer[gVramGraphicsCopyQueueIndex], gfx, sizeof(struct GraphicsData));                                  \
     gVramGraphicsCopyQueue[gVramGraphicsCopyQueueIndex] = &gVramGraphicsCopyQueueBuffer[gVramGraphicsCopyQueueIndex];                      \
     /* Log has to happen before gVramGraphicsCopyQueueIndex increment */                                                                   \
     GFX_QUEUE_LOG_ADD(gfx)                                                                                                                 \
     INC_GRAPHICS_QUEUE_CURSOR(gVramGraphicsCopyQueueIndex);
 #else
 #define ADD_TO_GRAPHICS_QUEUE(gfx)                                                                                                         \
-    TEST_GFX_POINTERS(gfx);                                                                                                                \
     gVramGraphicsCopyQueue[gVramGraphicsCopyQueueIndex] = gfx;                                                                             \
     /* Log has to happen before gVramGraphicsCopyQueueIndex increment */                                                                   \
     GFX_QUEUE_LOG_ADD(gfx)                                                                                                                 \
@@ -368,7 +354,7 @@ extern struct MultiBootParam gMultiBootParam;
 
 extern const struct SpriteTables *gRefSpriteTables;
 
-void GameInit(void);
-void GameLoop(void);
+void EngineInit(void);
+void EngineMainLoop(void);
 
 #endif