Refactor disk.c for generic use. Wired up uSD read for MBR/GPT

Author: dgarske

.github/workflows/test-build-riscv.yml

@@ -81,12 +81,21 @@ jobs:
         run: sudo apt-get update -o Acquire::Retries=3
 
       - name: Download and install RISC-V toolchains
+        if: ${{ inputs.arch == 'riscv' }}
         run: |
+          # Download SiFive prebuilt toolchain with newlib
+          wget -q https://static.dev.sifive.com/dev-tools/freedom-tools/v2020.12/riscv64-unknown-elf-toolchain-10.2.0-2020.12.8-x86_64-linux-ubuntu14.tar.gz
+          tar xzf riscv64-unknown-elf-toolchain-10.2.0-2020.12.8-x86_64-linux-ubuntu14.tar.gz
+          echo "$GITHUB_WORKSPACE/riscv64-unknown-elf-toolchain-10.2.0-2020.12.8-x86_64-linux-ubuntu14/bin" >> $GITHUB_PATH
+
           # Download latest prebuilt RISC-V toolchains
           #wget -q https://github.com/RISCV-Tools/riscv-gnu-toolchain/releases/latest/download/riscv32-elf-ubuntu-24.04-gcc.tar.xz
           #tar -xf riscv32-elf-ubuntu-24.04-gcc.tar.xz
           #echo "$GITHUB_WORKSPACE/riscv/bin" >> $GITHUB_PATH
 
+      - name: Download and install RISC-V toolchains
+        if: ${{ inputs.arch == 'riscv64' }}
+        run: |
           wget -q https://github.com/RISCV-Tools/riscv-gnu-toolchain/releases/latest/download/riscv64-elf-ubuntu-24.04-gcc.tar.xz
           tar -xf riscv64-elf-ubuntu-24.04-gcc.tar.xz
           echo "$GITHUB_WORKSPACE/riscv/bin" >> $GITHUB_PATH
@@ -106,7 +115,7 @@ jobs:
       - name: Build wolfboot (riscv32)
         if: ${{ inputs.arch == 'riscv' }}
         run: |
-          # using riscv64 for now since riscv64-unknown-elf- is missing "zicsr" extension
+          # using riscv64 for now since riscv32-unknown-elf- is missing "zicsr" extension
           make CROSS_COMPILE=riscv64-unknown-elf- FREEDOM_E_SDK=$GITHUB_WORKSPACE/freedom-e-sdk ${{inputs.make-args}}
 
       - name: Build wolfboot (riscv64))

Makefile

@@ -528,7 +528,7 @@ line-count-nrf52:
 	cloc --force-lang-def cloc_lang_def.txt src/boot_arm.c src/image.c src/libwolfboot.c src/loader.c src/update_flash.c hal/nrf52.c
 
 line-count-x86:
-	cloc --force-lang-def cloc_lang_def.txt src/boot_x86_fsp.c src/boot_x86_fsp_payload.c src/boot_x86_fsp_start.S src/image.c src/keystore.c src/libwolfboot.c src/loader.c src/string.c src/update_disk.c src/gpt.c src/x86/ahci.c src/x86/ata.c src/x86/common.c src/x86/disk.c src/x86/hob.c src/pci.c src/x86/tgl_fsp.c hal/x86_fsp_tgl.c hal/x86_uart.c
+	cloc --force-lang-def cloc_lang_def.txt src/boot_x86_fsp.c src/boot_x86_fsp_payload.c src/boot_x86_fsp_start.S src/image.c src/keystore.c src/libwolfboot.c src/loader.c src/string.c src/update_disk.c src/gpt.c src/x86/ahci.c src/x86/ata.c src/x86/common.c src/disk.c src/x86/hob.c src/pci.c src/x86/tgl_fsp.c hal/x86_fsp_tgl.c hal/x86_uart.c
 
 stack-usage: wolfboot.bin
 	$(Q)echo $(STACK_USAGE) > .stack_usage

arch.mk

@@ -563,9 +563,10 @@ endif
 ifeq ($(ARCH),RISCV64)
   CROSS_COMPILE?=riscv64-unknown-elf-
   CFLAGS+=-DMMU -DWOLFBOOT_DUALBOOT
-  CFLAGS+=-DWOLFBOOT_UPDATE_DISK
+  CFLAGS+=-DWOLFBOOT_UPDATE_DISK -DMAX_DISKS=1
   UPDATE_OBJS:=src/update_disk.o
   OBJS += src/gpt.o
+  OBJS += src/disk.o
   ARCH_FLAGS=-march=rv64imafd -mabi=lp64d -mcmodel=medany
   CFLAGS+=-fno-builtin-printf -DUSE_M_TIME -g -nostartfiles -DARCH_RISCV64
   CFLAGS+=$(ARCH_FLAGS)
@@ -1117,7 +1118,7 @@ ifeq ("${FSP}", "1")
     OBJS += src/x86/ahci.o
     OBJS += src/x86/ata.o
     OBJS += src/gpt.o
-    OBJS += src/x86/disk.o
+    OBJS += src/disk.o
     OBJS += src/x86/mptable.o
     OBJS += src/stage2_params.o
     OBJS += src/x86/exceptions.o

docs/Targets.md

@@ -879,10 +879,9 @@ set architecture riscv:rv64
 ### PolarFire Example Boot Output
 
 ```
-wolfBoot Version: 2.7.0 (Dec 17 2025 11:59:22)
-disk_open: drv = 0
+wolfBoot Version: 2.7.0 (Dec 17 2025 14:51:25)
 mmc_set_timeout: timeout_val 500000 (12)
-mmc_set_clock: clock_khz: 400, freq_khz: 400
+mmc_set_clock: requested khz: 400, actual khz: 400
 mmc_send_cmd: cmd_index: 0, cmd_arg: 00000000, resp_type: 0
 mmc_send_cmd: cmd_index: 8, cmd_arg: 00000100, resp_type: 9
 mmc_init: xpc:0, si8r:1, max_ma (3.3v:128 1.8v:128)
@@ -908,18 +907,33 @@ mmc_send_cmd: cmd_index: 6, cmd_arg: 00000002, resp_type: 1
 mmc_send_cmd: cmd_index: 13, cmd_arg: AAAA0000, resp_type: 1
 mmc_send_cmd: cmd_index: 16, cmd_arg: 00000008, resp_type: 1
 mmc_send_cmd: cmd_index: 55, cmd_arg: AAAA0000, resp_type: 1
-mmc_block_read: cmd_index: 51, block_addr: 00000000, dst 0x801FFCE0, sz: 8
+mmc_read: cmd_index: 51, block_addr: 00000000, dst 0x801FFCE0, sz: 8
 mmc_send_cmd: cmd_index: 13, cmd_arg: AAAA0000, resp_type: 1
+mmc_read: status: 0
 mmc_send_cmd: cmd_index: 13, cmd_arg: AAAA0000, resp_type: 1
-mmc_block_read: cmd_index: 6, block_addr: 00000001, dst 0x801FFC48, sz: 64
+mmc_read: cmd_index: 6, block_addr: 00000001, dst 0x801FFC48, sz: 64
 mmc_send_cmd: cmd_index: 13, cmd_arg: AAAA0000, resp_type: 1
+mmc_read: status: 0
 mmc_send_cmd: cmd_index: 13, cmd_arg: AAAA0000, resp_type: 1
-mmc_block_read: cmd_index: 6, block_addr: 80000001, dst 0x801FFC48, sz: 64
+mmc_read: cmd_index: 6, block_addr: 80000001, dst 0x801FFC48, sz: 64
 mmc_send_cmd: cmd_index: 13, cmd_arg: AAAA0000, resp_type: 1
-mmc_set_clock: clock_khz: 50000, freq_khz: 50000
-Checking primary OS image in 0,1...
-Checking secondary OS image in 0,2...
-No valid OS image found in either partition 1 or 2
+mmc_read: status: 0
+mmc_set_clock: requested khz: 50000, actual khz: 50000
+Reading MBR...
+disk_read: drv:0, start:0, count:512, dst:0x801FF918
+mmc_send_cmd: cmd_index: 13, cmd_arg: AAAA0000, resp_type: 1
+mmc_read: cmd_index: 17, block_addr: 00000000, dst 0x801FF918, sz: 512
+mmc_send_cmd: cmd_index: 13, cmd_arg: AAAA0000, resp_type: 1
+mmc_read: status: 0
+Found GPT PTE at sector 1
+Found valid boot signature in MBR
+disk_read: drv:0, start:512, count:512, dst:0x801FF918
+mmc_send_cmd: cmd_index: 13, cmd_arg: AAAA0000, resp_type: 1
+mmc_read: cmd_index: 17, block_addr: 00000200, dst 0x801FF918, sz: 512
+mmc_send_cmd: cmd_index: 13, cmd_arg: AAAA0000, resp_type: 1
+mmc_read: status: 0
+Invalid partition table
+Error opening disk 0
 wolfBoot: PANIC!
 ```
 

hal/mpfs250.c

@@ -31,7 +31,7 @@
 #include <string.h>
 #include <stdbool.h>
 
-#include <target.h>
+#include "target.h"
 
 #include "mpfs250.h"
 #include "image.h"
@@ -42,6 +42,7 @@
 #include "printf.h"
 #include "loader.h"
 #include "disk.h"
+#include "gpt.h"
 
 #define DEBUG_MMC
 
@@ -200,6 +201,7 @@ int mmc_set_timeout(uint32_t timeout_us)
     return 0;
 }
 
+/* TODO: Fix with real timer */
 void mmc_delay(uint32_t delay)
 {
     while (delay--) {
@@ -298,7 +300,7 @@ uint32_t mmc_set_clock(uint32_t clock_khz)
     last_clock_khz = clock_khz;
 
 #ifdef DEBUG_MMC
-    wolfBoot_printf("mmc_set_clock: clock_khz: %d, freq_khz: %d\n",
+    wolfBoot_printf("mmc_set_clock: requested khz: %d, actual khz: %d\n",
         clock_khz, freq_khz);
 #endif
 
@@ -453,8 +455,8 @@ int mmc_card_init(uint32_t acmd41_arg, uint32_t *ocr_reg)
     return status;
 }
 
-/* MMC_CMD17_READ_SINGLE */
-int mmc_block_read(uint32_t cmd_index, uint32_t block_addr, uint32_t* dst,
+/* MMC_CMD17_READ_SINGLE, MMC_CMD18_READ_MULTIPLE */
+int mmc_read(uint32_t cmd_index, uint32_t block_addr, uint32_t* dst,
     uint32_t sz)
 {
     int status;
@@ -483,7 +485,7 @@ int mmc_block_read(uint32_t cmd_index, uint32_t block_addr, uint32_t* dst,
     }
 
 #ifdef DEBUG_MMC
-    wolfBoot_printf("mmc_block_read: cmd_index: %d, block_addr: %08X, dst %p, sz: %d\n",
+    wolfBoot_printf("mmc_read: cmd_index: %d, block_addr: %08X, dst %p, sz: %d\n",
         cmd_index, block_addr, dst, sz);
 #endif
 
@@ -513,12 +515,13 @@ int mmc_block_read(uint32_t cmd_index, uint32_t block_addr, uint32_t* dst,
         status = mmc_wait_busy(0);
     }
     else {
-    #ifdef DEBUG_MMC
-        wolfBoot_printf("mmc_block_read: error: 0x%08X\n", reg);
-    #endif
-        status = -1;
+        status = -1; /* error */
     }
 
+#ifdef DEBUG_MMC
+    wolfBoot_printf("mmc_read: status: %d\n", status);
+#endif
+
     return status;
 }
 
@@ -567,10 +570,13 @@ static uint32_t get_srs_bits(int from, int count)
     return ret & mask;
 }
 
-int mmc_send_switch_function(uint32_t mode, uint32_t function_number, uint32_t group_number)
+/* check or set switch function/group:
+ * returns 0 if supported */
+int mmc_send_switch_function(uint32_t mode, uint32_t function_number,
+    uint32_t group_number)
 {
     int status;
-    uint32_t timeout = 4; /* up to 5 tries */
+    uint32_t timeout = 4;
     uint32_t cmd_arg;
     uint32_t func_status[64/sizeof(uint32_t)]; /* fixed 512 bits */
     uint8_t* p_func_status = (uint8_t*)func_status;
@@ -582,7 +588,7 @@ int mmc_send_switch_function(uint32_t mode, uint32_t function_number, uint32_t g
     cmd_arg = (function_number << ((group_number - 1) * 4));
     do {
         /* first run check to see if function is supported */
-        status = mmc_block_read(SD_CMD_6_SWITCH_FUNC,
+        status = mmc_read(SD_CMD_6_SWITCH_FUNC,
             (mode | cmd_arg),
             func_status, sizeof(func_status));
         if (status == 0) {
@@ -600,11 +606,12 @@ int mmc_send_switch_function(uint32_t mode, uint32_t function_number, uint32_t g
             /* supported: group 1 415:400 */
             if ((p_func_status[13 -
                     ((group_number-1)*2)] & (1 << function_number))) {
-                break; /* supported */
+                status = 0; /* supported */
             }
             else {
-                return -1; /* not supported */
+                status = -1; /* not supported */
             }
+            break;
         }
     } while (status == 0 && --timeout > 0); /* retry until function not busy */
     return status;
@@ -848,7 +855,7 @@ int mmc_init(void)
     if (status == 0) {
         /* Get SCR registers - 8 bytes */
         uint32_t scr_reg[SCR_REG_DATA_SIZE/sizeof(uint32_t)];
-        status = mmc_block_read(SD_ACMD51_SEND_SCR, 0, scr_reg,
+        status = mmc_read(SD_ACMD51_SEND_SCR, 0, scr_reg,
             sizeof(scr_reg));
     }
     if (status == 0) {
@@ -882,37 +889,58 @@ int mmc_init(void)
     return status;
 }
 
-/* TODO: Add support for reading uSD card with GPT (Global Partition Table) */
-/* The partition ID's are determined using BOOT_PART_A and BOOT_PART_B. */
-int disk_open(int drv)
+/* returns number of bytes read on success or negative on error */
+int disk_read(int drv, uint64_t start, uint32_t count, uint32_t *buf)
 {
-    wolfBoot_printf("disk_open: drv = %d\r\n", drv);
-    (void)drv;
-    return mmc_init();
+    int status = 0;
+    uint32_t read_sz;
+    uint8_t* p_buf = (uint8_t*)buf;
+    (void)drv; /* only one drive supported */
+
+#ifdef DEBUG_MMC
+    wolfBoot_printf("disk_read: drv:%d, start:%llu, count:%d, dst:%p\n",
+        drv, start, count, buf);
+#endif
+
+    while (count > 0) {
+        read_sz = count;
+        if (read_sz > EMMC_SD_BLOCK_SIZE) {
+            read_sz = EMMC_SD_BLOCK_SIZE;
+        }
+        status = mmc_read(MMC_CMD17_READ_SINGLE, start, (uint32_t*)p_buf, read_sz);
+        if (status != 0) {
+            return -1;
+        }
+        start += read_sz;
+        p_buf += read_sz;
+        count -= read_sz;
+    }
+    return status;
 }
-int disk_read(int drv, int part, uint64_t off, uint64_t sz, uint8_t *buf)
+
+int disk_write(int drv, uint64_t start, uint32_t count, const uint32_t *buf)
 {
+    /* not supported */
     (void)drv;
-    (void)part;
-    (void)off;
-    (void)sz;
+    (void)start;
+    (void)count;
     (void)buf;
     return 0;
 }
-int disk_write(int drv, int part, uint64_t off, uint64_t sz, const uint8_t *buf)
+
+int disk_init(int drv)
 {
+    int r = mmc_init();
+    if (r != 0) {
+        wolfBoot_printf("Failed to initialize MMC\n");
+    }
     (void)drv;
-    (void)part;
-    (void)off;
-    (void)sz;
-    (void)buf;
-    return 0;
+    return r;
 }
-int disk_find_partition_by_label(int drv, const char *label)
+
+void disk_close(int drv)
 {
     (void)drv;
-    (void)label;
-    return 0;
 }
 
 #ifdef DEBUG_UART

hal/mpfs250.h

@@ -877,6 +877,7 @@
 
 #define SCR_REG_DATA_SIZE 8
 
+
 /* Switch Function Command Arguments */
 #define SDCARD_SWITCH_FUNC_MODE_SWITCH       (0x1u << 31) /* Set function mode */
 #define SDCARD_SWITCH_FUNC_MODE_CHECK        (0x0u << 31) /* Check mode */

hal/x86_fsp_tgl.c

@@ -19,16 +19,22 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
  */
 
-#include <wolfboot/wolfboot.h>
+#include "wolfboot/wolfboot.h"
 #include <stdint.h>
-#include <uart_drv.h>
-#include <printf.h>
-#include <x86/ahci.h>
-#include <x86/ata.h>
-#include <x86/common.h>
 
 #ifdef __WOLFBOOT
 
+#include "uart_drv.h"
+#include "printf.h"
+#include "loader.h"
+
+#ifdef WOLFBOOT_FSP
+#include "x86/ahci.h"
+#include "x86/ata.h"
+#include "x86/common.h"
+#include "x86/tgl_fsp.h"
+#endif
+
 #if defined(TARGET_kontron_vx3060_s2)
 #define PCI_AHCI_BUS 0
 #define PCI_AHCI_DEV 0x17
@@ -39,6 +45,45 @@
 #define PCI_AHCI_FUN 2
 #endif
 
+#ifdef WOLFBOOT_FSP
+static uint32_t sata_bar;
+#endif
+
+int disk_init(int drv)
+{
+    int ret = 0;
+#ifdef WOLFBOOT_FSP
+    ret = x86_fsp_tgl_init_sata(&sata_bar);
+    if (ret != 0)
+        wolfBoot_panic();
+#ifdef WOLFBOOT_ATA_DISK_LOCK
+    ret = sata_unlock_disk(drv, 1);
+    if (ret != 0)
+        wolfBoot_panic();
+#endif
+#endif /* WOLFBOOT_FSP */
+    (void)drv;
+    return ret;
+}
+
+void disk_close(int drv)
+{
+#ifdef WOLFBOOT_FSP
+    sata_disable(sata_bar);
+#endif
+    (void)drv;
+}
+
+int disk_read(int drv, uint64_t start, uint32_t count, uint32_t *buf)
+{
+    return ata_drive_read(drv, start, count, (uint8_t*)buf);
+}
+
+int disk_write(int drv, uint64_t start, uint32_t count, const uint32_t *buf)
+{
+    return ata_drive_write(drv, start, count, (const uint8_t*)buf);
+}
+
 /*!
  * \brief Initializes the SATA controller.
  *