Document some CPU functions and add format workflow (#178)

* port stuff from oot-vc

* build issues

* missed one wrong type

* review

.github/workflows/format.yml

@@ -0,0 +1,32 @@
+name: Check Format
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  format:
+    runs-on: ubuntu-24.04
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+    # Checkout the repository (shallow clone)
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        submodules: recursive
+
+    # Set Git config
+    - name: Git config
+      run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+
+    # Run formatter
+    - name: Run clang-format
+      run: ./format
+
+    # Cancel if there's a diff
+    - name: Check status
+      run: git diff --name-only --exit-code

include/emulator/cpu.h

@@ -262,7 +262,7 @@ typedef struct CpuOptimize {
 } CpuOptimize; // size = 0x28
 
 typedef struct Cpu Cpu;
-typedef bool (*CpuExecuteFunc)(Cpu* pCPU, s32 nCount, s32 nAddressN64, s32 nAddressGCN);
+typedef s32 (*CpuExecuteFunc)(Cpu* pCPU, s32 nCount, s32 nAddressN64, s32 nAddressGCN);
 
 // _CPU
 struct Cpu {
@@ -350,7 +350,7 @@ struct Cpu {
 bool cpuFreeCachedAddress(Cpu* pCPU, s32 nAddress0, s32 nAddress1);
 bool cpuTestInterrupt(Cpu* pCPU, s32 nMaskIP);
 bool cpuException(Cpu* pCPU, CpuExceptionCode eCode, s32 nMaskIP);
-bool cpuExecute(Cpu* pCPU, u64 nAddressBreak);
+bool cpuExecute(Cpu* pCPU, s32 nCount, u64 nAddressBreak);
 bool cpuSetRegisterCP0(Cpu* pCPU, s32 iRegister, s64 nData);
 bool cpuGetRegisterCP0(Cpu* pCPU, s32 iRegister, s64* pnData);
 bool __cpuERET(Cpu* pCPU);