Self-update writes the new build to SD, then boots known-good /boot.dol
Previous version launched the image it had just received, which is the one
thing that cannot be made safe: a broken build hangs the console and the
checks can only catch a truncated or non-DOL image, never a plausible but
broken one.
The flow is now receive -> write to SD -> boot /boot.dol:
- netboot_sd_write() mounts the card (auto-detecting SD2SP2, then SD Gecko
slot B, then slot A), writes the image to the path the host asked for,
and READS IT BACK AND COMPARES. A half-written .dol that still parses is
exactly the failure this design exists to avoid, and the card is the one
component here with no other integrity check.
- netboot_boot_file() then loads /boot.dol -- a known-good Swiss -- and
launches that instead.
So the only image this ever jumps into is one that was already known good. A
broken test build costs nothing: Swiss comes up and can load anything,
including the previous build. If the SD write or verify fails, nothing is
launched at all and the menu is still there.
The destination path travels in the DONE frame rather than being baked in, so
the host decides where the build lands (send-dol.py --dest, default
/gc_bba_test.dol).
libfat is unmounted before the jump: leaving the card mounted hands the next
image a filesystem libfat still thinks it owns, on an EXI channel it is about
to reinitialise.
Note the SD Gecko in memory-card slot A shares EXI channel 0 with the BBA
(channel 0, device 2). libogc arbitrates, but SD2SP2 is on its own channel
and avoids the question -- hence the detection order.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
+20
-13
@@ -131,10 +131,10 @@ static void do_netboot(char *status, size_t nstatus)
|
||||
|
||||
printf("\n" C_HEAD " Self-update over the BBA" C_RESET "\n\n");
|
||||
printf(" On the host: sudo ./scripts/send-dol.py <iface> <file.dol>\n\n");
|
||||
printf(C_DIM " Send a KNOWN-GOOD image the first time -- Swiss's boot.dol\n"
|
||||
" is ideal: it is unmistakable when it boots, so it tells you the\n"
|
||||
" transfer AND the launcher both work before you trust either\n"
|
||||
" with an untested build.\n" C_RESET "\n");
|
||||
printf(C_DIM " The received build is WRITTEN TO THE SD CARD and verified;\n"
|
||||
" it is never launched directly. This then boots /boot.dol --\n"
|
||||
" your known-good Swiss -- so a broken test build costs nothing:\n"
|
||||
" Swiss comes up and can load whatever you like.\n" C_RESET "\n");
|
||||
printf(" Blocks until done or it times out (30 s idle, 5 s mid-xfer).\n\n");
|
||||
|
||||
if (!s_stage) {
|
||||
@@ -148,19 +148,26 @@ static void do_netboot(char *status, size_t nstatus)
|
||||
return;
|
||||
}
|
||||
|
||||
printf("\n launching %d bytes...\n", len);
|
||||
/* Give the console a frame to actually show that before we disable
|
||||
* interrupts and overwrite ourselves. */
|
||||
rc = netboot_sd_write(netboot_dest_path(), s_stage, (u32)len, nb_status);
|
||||
if (rc < 0) {
|
||||
/* Nothing has been launched and nothing is half-written that we
|
||||
* know of, so staying in the menu is the safe outcome. */
|
||||
snprintf(status, nstatus, "SD write failed (%d) - nothing launched", rc);
|
||||
return;
|
||||
}
|
||||
|
||||
printf("\n booting /boot.dol ...\n");
|
||||
VIDEO_WaitVSync();
|
||||
VIDEO_WaitVSync();
|
||||
|
||||
rc = netboot_launch(s_stage);
|
||||
/* Only reached on refusal. -2 = header implausible (truncated or not a
|
||||
* DOL); -3 = a section would land on the reserved staging region, which
|
||||
* would corrupt the image or the copier mid-flight. */
|
||||
/* Reuse the staging region: the new build is already on the card and
|
||||
* verified, so the copy in RAM is finished with. */
|
||||
rc = netboot_boot_file("/boot.dol", s_stage, s_stage_max, nb_status);
|
||||
|
||||
/* Only reached on refusal. The new build IS on the card either way,
|
||||
* so this is recoverable by rebooting into Swiss by hand. */
|
||||
snprintf(status, nstatus,
|
||||
rc == -3 ? "refused: image overlaps staging region"
|
||||
: "refused: not a plausible DOL");
|
||||
"update saved, but /boot.dol would not boot (%d)", rc);
|
||||
}
|
||||
|
||||
int main(void)
|
||||
|
||||
@@ -5,6 +5,8 @@
|
||||
#include <malloc.h>
|
||||
#include <ogc/lwp_watchdog.h>
|
||||
#include <ogc/cache.h>
|
||||
#include <fat.h>
|
||||
#include <sdcard/gcsd.h>
|
||||
|
||||
/* ── frame layout ────────────────────────────────────────────────────────
|
||||
* 0 dst MAC (6)
|
||||
@@ -85,6 +87,12 @@ static int send_ack(u16 seq)
|
||||
return bba_tx_bytes(f, sizeof(f));
|
||||
}
|
||||
|
||||
/* Destination path carried in the DONE frame, so the host decides where the
|
||||
* build lands rather than it being baked in here. */
|
||||
static char s_dest[64] = "/gc_bba_test.dol";
|
||||
|
||||
const char *netboot_dest_path(void) { return s_dest; }
|
||||
|
||||
int netboot_receive(void *dst, u32 maxlen, void (*status)(const char *msg))
|
||||
{
|
||||
static u8 frame[1536];
|
||||
@@ -136,6 +144,12 @@ int netboot_receive(void *dst, u32 maxlen, void (*status)(const char *msg))
|
||||
t0 = gettime();
|
||||
|
||||
if (frame[18] == NB_OP_DONE) {
|
||||
/* DONE may carry the destination path as its payload. */
|
||||
u16 plen = rd16(frame + 24);
|
||||
if (plen && plen < sizeof(s_dest) && NB_HDR + plen <= (u32)n) {
|
||||
memcpy(s_dest, frame + NB_HDR, plen);
|
||||
s_dest[plen] = 0;
|
||||
}
|
||||
if (status) { snprintf(line, sizeof(line),
|
||||
"received %u bytes in %u blocks",
|
||||
(unsigned)got, (unsigned)nblocks);
|
||||
@@ -291,3 +305,139 @@ int netboot_launch(const void *dol)
|
||||
stub(desc);
|
||||
return 0; /* not reached */
|
||||
}
|
||||
|
||||
/* ── SD card: save the new build, then boot a known-good image ───────────
|
||||
* The update deliberately does NOT launch what it just received. It writes
|
||||
* the image to the card and then boots /boot.dol (Swiss), so a broken test
|
||||
* build is recoverable: Swiss comes up regardless and can load the previous
|
||||
* one. The only image we ever jump into is one that was already known good. */
|
||||
|
||||
static int s_sd_mounted;
|
||||
|
||||
static int sd_mount(void (*status)(const char *msg))
|
||||
{
|
||||
/* Try every interface a GameCube might have. Auto-detecting beats
|
||||
* asking: SD Gecko can be in either memory-card slot, and SD2SP2 is on
|
||||
* its own EXI channel. */
|
||||
static const struct { const char *name; const DISC_INTERFACE *io; } ifs[] = {
|
||||
{ "SD2SP2", &__io_gcsd2 },
|
||||
{ "SD Gecko slot B", &__io_gcsdb },
|
||||
{ "SD Gecko slot A", &__io_gcsda },
|
||||
};
|
||||
unsigned i;
|
||||
char line[64];
|
||||
|
||||
if (s_sd_mounted) return 0;
|
||||
for (i = 0; i < sizeof(ifs) / sizeof(ifs[0]); i++) {
|
||||
if (fatMountSimple("sd", ifs[i].io)) {
|
||||
if (status) {
|
||||
snprintf(line, sizeof(line), "SD mounted (%s)", ifs[i].name);
|
||||
status(line);
|
||||
}
|
||||
s_sd_mounted = 1;
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
if (status) status("no SD card found (SD2SP2 or SD Gecko)");
|
||||
return -1;
|
||||
}
|
||||
|
||||
int netboot_sd_write(const char *path, const void *buf, u32 len,
|
||||
void (*status)(const char *msg))
|
||||
{
|
||||
char full[96], line[128];
|
||||
FILE *f;
|
||||
u32 done = 0;
|
||||
int rc = -1;
|
||||
|
||||
if (sd_mount(status) < 0) return -1;
|
||||
snprintf(full, sizeof(full), "sd:%s", path);
|
||||
|
||||
if (status) { snprintf(line, sizeof(line), "writing %s", full); status(line); }
|
||||
f = fopen(full, "wb");
|
||||
if (!f) {
|
||||
if (status) status("open for write failed");
|
||||
return -2;
|
||||
}
|
||||
done = (u32)fwrite(buf, 1, len, f);
|
||||
fclose(f);
|
||||
if (done != len) {
|
||||
if (status) status("short write");
|
||||
return -3;
|
||||
}
|
||||
|
||||
/* Read it back. A half-written .dol that still parses is exactly the
|
||||
* failure this whole design exists to avoid, and the card is the one
|
||||
* component here with no other integrity check. */
|
||||
if (status) status("verifying...");
|
||||
f = fopen(full, "rb");
|
||||
if (!f) {
|
||||
if (status) status("reopen for verify failed");
|
||||
return -4;
|
||||
}
|
||||
{
|
||||
static u8 chunk[4096];
|
||||
const u8 *src = (const u8 *)buf;
|
||||
u32 off = 0;
|
||||
rc = 0;
|
||||
while (off < len) {
|
||||
u32 want = len - off;
|
||||
if (want > sizeof(chunk)) want = sizeof(chunk);
|
||||
if (fread(chunk, 1, want, f) != want) { rc = -5; break; }
|
||||
if (memcmp(chunk, src + off, want) != 0) { rc = -6; break; }
|
||||
off += want;
|
||||
}
|
||||
}
|
||||
fclose(f);
|
||||
if (rc < 0) {
|
||||
if (status) status("VERIFY FAILED - card image is not what we sent");
|
||||
return rc;
|
||||
}
|
||||
if (status) { snprintf(line, sizeof(line), "wrote and verified %u bytes",
|
||||
(unsigned)len); status(line); }
|
||||
return 0;
|
||||
}
|
||||
|
||||
int netboot_boot_file(const char *path, void *dst, u32 maxlen,
|
||||
void (*status)(const char *msg))
|
||||
{
|
||||
char full[96], line[128];
|
||||
FILE *f;
|
||||
long sz;
|
||||
u32 got;
|
||||
|
||||
if (sd_mount(status) < 0) return -1;
|
||||
snprintf(full, sizeof(full), "sd:%s", path);
|
||||
|
||||
f = fopen(full, "rb");
|
||||
if (!f) {
|
||||
if (status) { snprintf(line, sizeof(line), "%s not found", full);
|
||||
status(line); }
|
||||
return -2;
|
||||
}
|
||||
fseek(f, 0, SEEK_END);
|
||||
sz = ftell(f);
|
||||
fseek(f, 0, SEEK_SET);
|
||||
if (sz <= 0 || (u32)sz > maxlen) {
|
||||
fclose(f);
|
||||
if (status) status("boot image size implausible");
|
||||
return -3;
|
||||
}
|
||||
got = (u32)fread(dst, 1, (size_t)sz, f);
|
||||
fclose(f);
|
||||
if (got != (u32)sz) {
|
||||
if (status) status("short read of boot image");
|
||||
return -4;
|
||||
}
|
||||
|
||||
if (status) { snprintf(line, sizeof(line), "booting %s (%u bytes)",
|
||||
full, (unsigned)got); status(line); }
|
||||
|
||||
/* Unmount before we disable interrupts and jump: leaving the card
|
||||
* mounted hands the next image a filesystem that libfat still thinks it
|
||||
* owns, on an EXI channel it is about to reinitialise. */
|
||||
fatUnmount("sd");
|
||||
s_sd_mounted = 0;
|
||||
|
||||
return netboot_launch(dst);
|
||||
}
|
||||
|
||||
@@ -45,6 +45,30 @@ void *netboot_reserve(u32 *out_max);
|
||||
int netboot_receive(void *dst, u32 maxlen,
|
||||
void (*status)(const char *msg));
|
||||
|
||||
/* Mount whichever SD interface is present (SD Gecko slot A or B, or SD2SP2)
|
||||
* and write `len` bytes to `path` (e.g. "/gc_bba_test.dol"), verifying the
|
||||
* result by reading it back. Returns 0 on success, <0 on error.
|
||||
*
|
||||
* NOTE the SD Gecko in memory-card slot A shares EXI channel 0 with the BBA
|
||||
* (which is channel 0, device 2). libogc arbitrates, but SD2SP2 -- on its own
|
||||
* channel -- avoids the question entirely. */
|
||||
int netboot_sd_write(const char *path, const void *buf, u32 len,
|
||||
void (*status)(const char *msg));
|
||||
|
||||
/* Read `path` off the SD card into `dst` and launch it. Does not return on
|
||||
* success. Returns <0 if it cannot be read or is not a plausible DOL.
|
||||
*
|
||||
* This is how the update completes: we NEVER jump into the image we just
|
||||
* received, only into a known-good /boot.dol (Swiss). A broken test build
|
||||
* therefore costs nothing -- Swiss still comes up and can load whatever you
|
||||
* want, including the previous build. */
|
||||
int netboot_boot_file(const char *path, void *dst, u32 maxlen,
|
||||
void (*status)(const char *msg));
|
||||
|
||||
/* Destination path the host asked for in its DONE frame (default
|
||||
* "/gc_bba_test.dol"). */
|
||||
const char *netboot_dest_path(void);
|
||||
|
||||
/* Launch a .dol image already in memory. Does not return on success.
|
||||
* Returns <0 if the image is not a plausible DOL. */
|
||||
int netboot_launch(const void *dol);
|
||||
|
||||
Reference in New Issue
Block a user