Rebase the mcp_recovery branch and merge it to main (#59)

* Rebase the mcp_recovery branch on v0.6.

FIXME: Graphical issues.
- Framebuffer seems to be 1280x720, even though the output is 480p.
- Some of the colors are incorrect.

* gfx.c: Fix color issues in mcp_recovery.

mcp_recovery uses XRGB, same as the DC_INIT builds
(but not regular builds).

This *was* in the original mcp_recovery branch, but I missed it
when manually rebasing.

* gfx.c: Use TV scaling for rects and text.

Even though it's using 480p output, it seems the framebuffer is still
internally 1280x720.

-----------------------------

Co-authored-by: GaryOderNichts <12049776+GaryOderNichts@users.noreply.github.com>

Author: GerbilSoft

ios_kernel/Makefile

@@ -50,6 +50,10 @@ LDFLAGS := -nostartfiles -nodefaultlibs -mbig-endian -flto \
 
 LIBS	:= -lgcc
 
+ifeq ($(MCP_RECOVERY), 1)
+	CFLAGS += -DMCP_RECOVERY
+endif
+
 #---------------------------------------------------------------------------------
 # list of directories containing libraries, this must be the top level
 # containing include and lib

ios_kernel/source/main.c

@@ -63,8 +63,13 @@ int _main(void* arg)
     // redirect __sys_write0 to lolserial
     *(volatile uint32_t*) 0x0812dd68 = ARM_B(0x0812dd68, (uint32_t) &svcAB_handler);
 
+#ifdef MCP_RECOVERY
+    // hook memcpy called on every /dev/mcp_recovery ioctl to start menu thread
+    *(volatile uint32_t*) (0x0510f4a0 - 0x05100000 + 0x13d80000) = THUMB_BL(0x0510f4a0, _MCP_recovery_ioctl_memcpy_hook);
+#else /* !MCP_RECOVERY */
     // add mcp ioctl hook to start mcp thread
     *(volatile uint32_t*) (0x05025242 - 0x05000000 + 0x081c0000) = THUMB_BL(0x05025242, _MCP_ioctl100_patch);
+#endif /* MCP_RECOVERY */
 
     // replace custom kernel syscall
     *(volatile uint32_t*) 0x0812cd2c = ARM_B(0x0812cd2c, kernel_syscall_0x81);
@@ -94,10 +99,19 @@ int _main(void* arg)
     setClientCapabilities(currentThreadContext->pid, 0xd, 0xffffffffffffffffllu);
 
     // start mcp thread
+#ifdef MCP_RECOVERY
+    int mcpHandle = IOS_Open("/dev/mcp_recovery", 0);
+#else /* !MCP_RECOVERY */
     int mcpHandle = IOS_Open("/dev/mcp", 0);
+#endif /* MCP_RECOVERY */
     if (mcpHandle > 0) {
         lolserial_printf("Starting MCP thread...\n");
+#ifdef MCP_RECOVERY
+        // send any ioctl to /dev/mcp_recovery to trigger hook
+        IOS_Ioctl(mcpHandle, 0, NULL, 0, NULL, 0);
+#else /* !MCP_RECOVERY */
         IOS_Ioctl(mcpHandle, 100, NULL, 0, NULL, 0);
+#endif /* MCP_RECOVERY */
 
         IOS_Close(mcpHandle);
     } else {

ios_mcp/Makefile

@@ -55,6 +55,12 @@ LIBS	:= -lgcc
 ifeq ($(DC_INIT), 1)
 	CFLAGS += -DDC_INIT
 endif
+ifeq ($(MCP_RECOVERY), 1)
+	CFLAGS += -DMCP_RECOVERY
+	SOURCES += source/mcp_recovery
+else
+	SOURCES += source/mcp_normal
+endif
 
 #---------------------------------------------------------------------------------
 # list of directories containing libraries, this must be the top level

ios_mcp/source/gfx.c

@@ -4,6 +4,14 @@
 #include <stdio.h>
 #include <stdarg.h>
 
+#ifdef MCP_RECOVERY
+// mcp_recovery does something different with framebuffer handling.
+// Only TV is usable; DRC isn't initialized.
+static uint32_t* framebuffer;
+static uint32_t width;
+static uint32_t height;
+#else /* !MCP_RECOVERY */
+
 static uint32_t* const TV_FRAMEBUFFER = (uint32_t*)(0x14000000 + 0x3500000);
 #define TV_HEIGHT 720
 #define TV_STRIDE 1280
@@ -12,6 +20,8 @@ static uint32_t* const DRC_FRAMEBUFFER = (uint32_t*)(0x14000000 + 0x38c0000);
 #define DRC_HEIGHT 480
 #define DRC_STRIDE 896
 
+#endif /* MCP_RECOVERY */
+
 #define CHAR_SIZE_TV_X 12
 #define CHAR_SIZE_TV_Y 24
 
@@ -50,53 +60,90 @@ int gfx_init_font(void)
     return 0;
 }
 
+#ifdef MCP_RECOVERY
+void gfx_init(void* fb, uint32_t w, uint32_t h)
+{
+    framebuffer = (uint32_t*) fb;
+    width = w;
+    height = h;
+}
+#endif /* MCP_RECOVERY */
+
 void gfx_clear(uint32_t col)
 {
-#ifdef DC_INIT
+#if defined(DC_INIT) || defined(MCP_RECOVERY)
     // both DC configurations use XRGB instead of RGBX
     col >>= 8;
-#endif
+#endif /* DC_INIT || MCP_RECOVERY */
 
+#ifdef MCP_RECOVERY
+    for (uint32_t i = 0; i < width * height; i++) {
+        framebuffer[i] = col;
+    }
+#else /* !MCP_RECOVERY */
     for (uint32_t i = 0; i < TV_STRIDE * TV_HEIGHT; i++) {
         TV_FRAMEBUFFER[i] = col;
     }
 
     for (uint32_t i = 0; i < DRC_STRIDE * DRC_HEIGHT; i++) {
         DRC_FRAMEBUFFER[i] = col;
     }
+#endif /* MCP_RECOVERY */
 }
 
 void gfx_draw_pixel(uint32_t x, uint32_t y, uint32_t col)
 {
-#ifdef DC_INIT
+#if defined(DC_INIT) || defined(MCP_RECOVERY)
     // both DC configurations use XRGB instead of RGBX
     col >>= 8;
-#endif
+#endif /* DC_INIT || MCP_RECOVERY */
 
+#ifndef MCP_RECOVERY
     // put pixel in the drc buffer
     uint32_t i = x + y * DRC_STRIDE;
     if (i < DRC_STRIDE * DRC_HEIGHT) {
         DRC_FRAMEBUFFER[i] = col;
     }
+#endif /* !MCP_RECOVERY */
 
     // scale and put pixel in the tv buffer
     for (uint32_t yy = (y * 1.5f); yy < ((y * 1.5f) + 1); yy++) {
         for (uint32_t xx = (x * 1.5f); xx < ((x * 1.5f) + 1); xx++) {
+#ifdef MCP_RECOVERY
+            uint32_t i = xx + yy * width;
+            if (i < width * height) {
+                framebuffer[i] = col;
+            }
+#else /* !MCP_RECOVERY */
             uint32_t i = xx + yy * TV_STRIDE;
             if (i < TV_STRIDE * TV_HEIGHT) {
                 TV_FRAMEBUFFER[i] = col;
             }
+#endif /* MCP_RECOVERY */
         }
     }
 }
 
 void gfx_draw_rect_filled(uint32_t x, uint32_t y, uint32_t w, uint32_t h, uint32_t col)
 {
-#ifdef DC_INIT
+#if defined(DC_INIT) || defined(MCP_RECOVERY)
     // both DC configurations use XRGB instead of RGBX
     col >>= 8;
-#endif
+#endif /* DC_INIT || MCP_RECOVERY */
+
+#ifdef MCP_RECOVERY
+    // mcp_recovery: Using TV scale because mcp_recovery seems to have a
+    // 1280x720 framebuffer, even though the output mode is usually 480p.
+    uint32_t* p = framebuffer + ((uint32_t)(y * 1.5f) * width) + (uint32_t)(x * 1.5f);
+    uint32_t stride_diff = width - (w * 1.5f);
 
+    for (uint32_t hcnt = (h * 1.5f); hcnt > 0; hcnt--) {
+        for (uint32_t wcnt = (w * 1.5f); wcnt > 0; wcnt--) {
+            *p++ = col;
+        }
+        p += stride_diff;
+    }
+#else /* !MCP_RECOVERY */
     // DRC fill: normal scale
     uint32_t* p = DRC_FRAMEBUFFER + (y * DRC_STRIDE) + x;
     uint32_t stride_diff = DRC_STRIDE - w;
@@ -118,6 +165,7 @@ void gfx_draw_rect_filled(uint32_t x, uint32_t y, uint32_t w, uint32_t h, uint32
         }
         p += stride_diff;
     }
+#endif /* MCP_RECOVERY */
 }
 
 void gfx_draw_rect(uint32_t x, uint32_t y, uint32_t w, uint32_t h, uint32_t borderSize, uint32_t col)
@@ -130,10 +178,10 @@ void gfx_draw_rect(uint32_t x, uint32_t y, uint32_t w, uint32_t h, uint32_t bord
 
 void gfx_set_font_color(uint32_t col)
 {
-#ifdef DC_INIT
+#if defined(DC_INIT) || defined(MCP_RECOVERY)
     // both DC configurations use XRGB instead of RGBX
     col >>= 8;
-#endif
+#endif /* DC_INIT || MCP_RECOVERY */
 
     font_color = col;
 }
@@ -152,6 +200,25 @@ static void gfx_draw_char(uint32_t x, uint32_t y, char c)
         return;
     c -= 32;
 
+#ifdef MCP_RECOVERY
+    // mcp_recovery: Terminus 12x24 bold
+    // Using TV scale because mcp_recovery seems to have a 1280x720
+    // framebuffer, even though the output mode is usually 480p.
+    const uint16_t* charMCP = font->ter_u24b[(unsigned char)c];
+    uint32_t *p = framebuffer + ((uint32_t)(y * 1.5f) * width) + (uint32_t)(x * 1.5f);
+    unsigned int stride_diff = width - CHAR_SIZE_TV_X;
+
+    for (uint32_t hcnt = CHAR_SIZE_TV_Y; hcnt > 0; hcnt--) {
+        uint16_t v = *charMCP++;
+        for (uint32_t wcnt = CHAR_SIZE_TV_X; wcnt > 0; wcnt--, v >>= 1) {
+            if (v & 1) {
+                *p = font_color;
+            }
+            p++;
+        }
+        p += stride_diff;
+    }
+#else /* !MCP_RECOVERY */
     // DRC blit: Terminus 8x16 bold
     const uint8_t* charDRC = font->ter_u16b[(unsigned char)c];
     uint32_t *p = DRC_FRAMEBUFFER + (y * DRC_STRIDE) + x;
@@ -183,6 +250,7 @@ static void gfx_draw_char(uint32_t x, uint32_t y, char c)
         }
         p += stride_diff;
     }
+#endif /* !MCP_RECOVERY */
 }
 
 /**

ios_mcp/source/gfx.h

@@ -21,6 +21,10 @@
 
 int gfx_init_font(void);
 
+#ifdef MCP_RECOVERY
+void gfx_init(void* fb, uint32_t w, uint32_t h);
+#endif /* MCP_RECOVERY */
+
 void gfx_clear(uint32_t color);
 
 void gfx_draw_pixel(uint32_t x, uint32_t y, uint32_t color);

ios_mcp/source/mcp_ioctl100.c ios_mcp/source/mcp_normal/mcp_ioctl100.cios_mcp/source/mcp_ioctl100.c renamed to ios_mcp/source/mcp_normal/mcp_ioctl100.c

@@ -0,0 +1,25 @@
+#include "imports.h"
+#include "menu.h"
+
+#include <string.h>
+
+static int threadStarted = 0;
+static uint8_t threadStack[0x1000] __attribute__((aligned(0x20)));
+
+void* MCP_recovery_ioctl_memcpy_hook(void* dst, void* src, uint32_t size)
+{
+    printf("MCP_recovery_ioctl_memcpy_hook\n");
+
+    // start the menu thread
+    if (!threadStarted) {
+        int tid = IOS_CreateThread(menuThread, NULL, threadStack + sizeof(threadStack), sizeof(threadStack), IOS_GetThreadPriority(0), 1);
+        if (tid > 0) {
+            IOS_StartThread(tid);
+        }
+
+        threadStarted = 1;
+    }
+
+    // perform the original copy
+    return memcpy(dst, src, size);
+}

ios_mcp/source/mcp_ioctl100_asm.s …mcp/source/mcp_normal/mcp_ioctl100_asm.sios_mcp/source/mcp_ioctl100_asm.s renamed to ios_mcp/source/mcp_normal/mcp_ioctl100_asm.s ios_mcp/source/mcp_ioctl100_asm.s renamed to ios_mcp/source/mcp_normal/mcp_ioctl100_asm.s

@@ -0,0 +1,9 @@
+.extern MCP_recovery_ioctl_memcpy_hook
+.global _MCP_recovery_ioctl_memcpy_hook
+_MCP_recovery_ioctl_memcpy_hook:
+    .thumb
+    bx pc
+    nop
+    .arm
+    ldr r12, =MCP_recovery_ioctl_memcpy_hook
+    bx r12

ios_mcp/source/mcp_recovery/mcp_recovery_hook.c

@@ -368,7 +368,7 @@ int menuThread(void* arg)
     // Initialize utils
     initializeUtils();
 
-#ifdef DC_INIT
+#if defined(DC_INIT)
     // (re-)init the graphics subsystem
     GFX_SubsystemInit(0);
 
@@ -383,6 +383,17 @@ int menuThread(void* arg)
        Writing to the hardcoded addresses in gfx.c works for HDMI though */
     DC_Config dc_config;
     DISPLAY_ReadDCConfig(&dc_config);
+#elif defined(MCP_RECOVERY)
+    // init display output (already initialized in recovery mode)
+    DISPLAY_DCInit(DC_CONFIGURATION_1);
+
+    // MCP is doing something different in recovery mode to make display configuration work properly
+    // this doesn't work usually
+    DC_Config dc_config;
+    DISPLAY_ReadDCConfig(&dc_config);
+
+    printf("DC Config: %p %ux%u\n", dc_config.framebuffer, dc_config.width, dc_config.height);
+    gfx_init(dc_config.framebuffer, dc_config.width, dc_config.height);
 #endif
 
     // initialize the font