Move wolfHAL integration into existing stm32h5 port

Author: AlexLanzano

.github/workflows/wolfhal-stm32h563zi-nucleo.yml

@@ -25,13 +25,14 @@ jobs:
           set -euo pipefail
           git clone --depth 1 https://github.com/wolfSSL/wolfHAL.git ../wolfHAL
 
-      - name: Build wolfHAL port
+      - name: Build STM32H563 port with the wolfHAL driver backend
         run: |
           set -euo pipefail
-          make -C src/port/wolfHAL BOARD=stm32h563zi_nucleo
+          make -C src/port/stm32h563 ENABLE_WOLFHAL=1 BOARD=stm32h563zi_nucleo \
+            CC=arm-none-eabi-gcc OBJCOPY=arm-none-eabi-objcopy
 
       - name: Verify binary
         run: |
           set -euo pipefail
-          test -f src/port/wolfHAL/build/stm32h563zi_nucleo/app.bin
-          arm-none-eabi-size src/port/wolfHAL/build/stm32h563zi_nucleo/app.elf
+          test -f src/port/stm32h563/app.bin
+          arm-none-eabi-size src/port/stm32h563/app.elf

Makefile

@@ -150,8 +150,8 @@ CPPCHECK_FLAGS=--enable=warning,performance,portability,missingInclude \
 			   --suppress=comparePointers:src/port/rp2350_cyw43439/syscalls.c \
 			   --suppress=unknownMacro:src/port/stm32h563/dot1x_client.c \
 			   --suppress=preprocessorErrorDirective:src/supplicant/supplicant_features.h \
-			   --suppress=comparePointers:src/port/wolfHAL/boards/stm32h563zi_nucleo/startup.c \
-			   --suppress=comparePointers:src/port/wolfHAL/boards/stm32h563zi_nucleo/syscalls.c \
+			   --suppress=comparePointers:src/port/stm32h563/boards/stm32h563zi_nucleo/startup.c \
+			   --suppress=comparePointers:src/port/stm32h563/boards/stm32h563zi_nucleo/syscalls.c \
 			   --disable=style \
 			   --std=c99 --language=c \
 			   --platform=unix64 \

src/port/stm32h563/Makefile

@@ -7,6 +7,14 @@ ROOT := ../../..
 # Default is TZEN=0 (TrustZone disabled)
 TZEN ?= 0
 
+# wolfHAL driver backend: set ENABLE_WOLFHAL=1 to build the port on top of
+# the wolfHAL HAL (Ethernet MAC/PHY, RNG, UART, GPIO, clocks) instead of the
+# in-tree bare-metal drivers. Selects the self-contained board directory
+# boards/$(BOARD). First cut supports TZEN=0 and FREERTOS=0 only.
+ENABLE_WOLFHAL ?= 0
+BOARD ?= stm32h563zi_nucleo
+WOLFHAL_ROOT ?= $(ROOT)/../wolfHAL
+
 # TLS support: set ENABLE_TLS=1 to include wolfSSL TLS server
 # Requires wolfSSL cloned alongside wolfip (or set WOLFSSL_ROOT)
 ENABLE_TLS ?= 0
@@ -122,6 +130,44 @@ CFLAGS_WOLFSSL := $(filter-out -Werror,$(CFLAGS_WOLFSSL))
 CFLAGS_WOLFSSL += -Wno-unused-variable -Wno-unused-function
 CFLAGS_WOLFSSL += $(EXTRA_CFLAGS_WOLFSSL)
 
+ifeq ($(ENABLE_WOLFHAL),1)
+# -----------------------------------------------------------------------------
+# wolfHAL driver backend
+# -----------------------------------------------------------------------------
+# board_init() programs the PLL directly and the wolfHAL SysTick driver owns
+# the SysTick handler, so the wolfBoot-launched (TZEN=1) clock flow and the
+# FreeRTOS SysTick are not supported in this first cut.
+ifeq ($(TZEN),1)
+  $(error ENABLE_WOLFHAL=1 does not support TZEN=1 yet (board_init owns the PLL, which conflicts with the wolfBoot-launched NS clock flow))
+endif
+ifeq ($(FREERTOS),1)
+  $(error ENABLE_WOLFHAL=1 does not support FREERTOS=1 yet (wolfHAL SysTick conflicts with the FreeRTOS SysTick handler))
+endif
+
+ifeq ($(wildcard $(WOLFHAL_ROOT)/wolfHAL/wolfHAL.h),)
+  $(error wolfHAL not found at $(WOLFHAL_ROOT). Clone it alongside wolfip: git clone https://github.com/wolfSSL/wolfHAL.git (or set WOLFHAL_ROOT))
+endif
+
+BOARD_DIR := boards/$(BOARD)
+
+CFLAGS += -DENABLE_WOLFHAL -DTZEN_ENABLED=0
+CFLAGS += -I$(WOLFHAL_ROOT) -I$(BOARD_DIR) -I$(ROOT)/src/port/wolfHAL
+
+LDSCRIPT := $(BOARD_DIR)/linker.ld
+
+# The board dir carries its own wolfHAL-specific startup/ivt/syscalls; the
+# bare-metal stm32_eth.c driver is replaced by board.c (BSP bringup) plus the
+# generic wolfhal_eth.c bridge.
+SRCS := $(BOARD_DIR)/startup.c $(BOARD_DIR)/ivt.c $(BOARD_DIR)/syscalls.c
+SRCS += main.c $(BOARD_DIR)/board.c $(ROOT)/src/port/wolfHAL/wolfhal_eth.c
+SRCS += $(ROOT)/src/wolfip.c
+
+# wolfHAL driver selection (WHAL_CFG_* defines) + wolfHAL driver TUs.
+include $(BOARD_DIR)/board.mk
+else
+# -----------------------------------------------------------------------------
+# In-tree bare-metal drivers (default)
+# -----------------------------------------------------------------------------
 # Select linker script based on TZEN setting
 ifeq ($(TZEN),1)
   LDSCRIPT := target_tzen.ld
@@ -131,11 +177,12 @@ else
   CFLAGS += -DTZEN_ENABLED=0
 endif
 
-LDFLAGS := -nostdlib -T $(LDSCRIPT) -Wl,-gc-sections
-
 # Base source files
 SRCS := startup.c ivt.c syscalls.c
 SRCS += main.c $(ROOT)/src/port/stm32/stm32_eth.c $(ROOT)/src/wolfip.c
+endif
+
+LDFLAGS := -nostdlib -T $(LDSCRIPT) -Wl,-gc-sections
 
 ifeq ($(FREERTOS),1)
 ifeq ($(wildcard $(FREERTOS_PATH)/include/FreeRTOS.h),)
@@ -515,7 +562,7 @@ endif
 OBJS := $(patsubst %.c,%.o,$(SRCS))
 
 all: app.bin
-	@echo "Built with TZEN=$(TZEN) ENABLE_TLS=$(ENABLE_TLS) ENABLE_TLS_CLIENT=$(ENABLE_TLS_CLIENT) ENABLE_HTTPS=$(ENABLE_HTTPS) ENABLE_SSH=$(ENABLE_SSH) ENABLE_MQTT=$(ENABLE_MQTT) ENABLE_MQTT_BROKER=$(ENABLE_MQTT_BROKER) FREERTOS=$(FREERTOS)"
+	@echo "Built with TZEN=$(TZEN) ENABLE_WOLFHAL=$(ENABLE_WOLFHAL) ENABLE_TLS=$(ENABLE_TLS) ENABLE_TLS_CLIENT=$(ENABLE_TLS_CLIENT) ENABLE_HTTPS=$(ENABLE_HTTPS) ENABLE_SSH=$(ENABLE_SSH) ENABLE_MQTT=$(ENABLE_MQTT) ENABLE_MQTT_BROKER=$(ENABLE_MQTT_BROKER) FREERTOS=$(FREERTOS)"
 ifeq ($(ENABLE_TLS),1)
 	@echo "  wolfSSL: $(WOLFSSL_ROOT)"
 endif
@@ -576,6 +623,11 @@ factory: factory.bin
 $(WOLFSSL_ROOT)/%.o: $(WOLFSSL_ROOT)/%.c
 	$(CC) $(CFLAGS_WOLFSSL) -DWOLFSSL_USER_SETTINGS $(if $(filter 1,$(ENABLE_SSH)),-DENABLE_SSH -DWOLFSSL_WOLFSSH) $(if $(filter 1,$(ENABLE_MQTT_BROKER)),-DENABLE_MQTT_BROKER) $(if $(filter 1,$(ENABLE_DOT1X)),-DHAVE_PBKDF2 -DHAVE_AES_KEYWRAP) -I$(WOLFSSL_ROOT) -c $< -o $@
 
+# wolfHAL driver objects: first-party HAL, but built with -Werror relaxed
+# since the port's -Wextra is stricter than wolfHAL's own build.
+$(WOLFHAL_ROOT)/%.o: $(WOLFHAL_ROOT)/%.c
+	$(CC) $(filter-out -Werror,$(CFLAGS)) -c $< -o $@
+
 clean:
 	rm -f *.o app.elf app.bin
 	rm -f app_v1_signed.bin factory.bin wolfboot_padded.bin
@@ -584,6 +636,10 @@ clean:
 	rm -f $(ROOT)/src/port/stm32/*.o
 	rm -f $(ROOT)/src/port/freeRTOS/*.o
 	rm -f $(ROOT)/src/supplicant/*.o
+ifeq ($(ENABLE_WOLFHAL),1)
+	rm -f boards/$(BOARD)/*.o
+	rm -f $(WOLFHAL_ROOT)/src/*.o $(WOLFHAL_ROOT)/src/*/*.o
+endif
 ifeq ($(FREERTOS),1)
 	rm -f $(FREERTOS_PATH)/*.o
 	rm -f $(FREERTOS_PATH)/portable/MemMang/*.o
@@ -614,7 +670,7 @@ verify: app.bin
 	@strings app.bin | grep -q "MQTT Broker: Initializing" && echo "  ✓ MQTT broker enabled" || echo "  ✗ MQTT broker disabled"
 	@echo ""
 	@echo "Binary size: $$(ls -lh app.bin | awk '{print $$5}')"
-	@echo "Build flags: TZEN=$(TZEN) ENABLE_TLS=$(ENABLE_TLS) ENABLE_HTTPS=$(ENABLE_HTTPS) ENABLE_SSH=$(ENABLE_SSH) ENABLE_MQTT=$(ENABLE_MQTT) ENABLE_MQTT_BROKER=$(ENABLE_MQTT_BROKER) FREERTOS=$(FREERTOS)"
+	@echo "Build flags: TZEN=$(TZEN) ENABLE_WOLFHAL=$(ENABLE_WOLFHAL) ENABLE_TLS=$(ENABLE_TLS) ENABLE_HTTPS=$(ENABLE_HTTPS) ENABLE_SSH=$(ENABLE_SSH) ENABLE_MQTT=$(ENABLE_MQTT) ENABLE_MQTT_BROKER=$(ENABLE_MQTT_BROKER) FREERTOS=$(FREERTOS)"
 
 # Show memory usage
 size: app.elf
@@ -643,6 +699,8 @@ help:
 	@echo ""
 	@echo "Options:"
 	@echo "  TZEN=1          Enable TrustZone support"
+	@echo "  ENABLE_WOLFHAL=1 Use the wolfHAL driver backend (requires wolfHAL; TZEN=0, FREERTOS=0)"
+	@echo "  BOARD=<name>    Board under boards/ (default: stm32h563zi_nucleo)"
 	@echo "  ENABLE_TLS=1    Enable TLS server (requires wolfSSL)"
 	@echo "  ENABLE_TLS_CLIENT=1 Enable TLS client test (Google)"
 	@echo "  ENABLE_HTTPS=1  Enable HTTPS web server (requires TLS)"
@@ -655,11 +713,13 @@ help:
 	@echo "  WOLFSSL_ROOT=   Path to wolfSSL (default: ../wolfssl)"
 	@echo "  WOLFSSH_ROOT=   Path to wolfSSH (default: ../wolfssh)"
 	@echo "  WOLFMQTT_ROOT=  Path to wolfMQTT (default: ../wolfmqtt)"
+	@echo "  WOLFHAL_ROOT=   Path to wolfHAL (default: ../wolfHAL)"
 	@echo "  CC=             C compiler (default: arm-none-eabi-gcc)"
 	@echo "  OBJCOPY=        Objcopy tool (default: arm-none-eabi-objcopy)"
 	@echo ""
 	@echo "Examples:"
 	@echo "  make                                                        # Basic TCP echo (port 7)"
+	@echo "  make ENABLE_WOLFHAL=1                                       # Basic TCP echo via the wolfHAL driver backend"
 	@echo "  make ENABLE_TLS=1                                           # TLS echo server (port 8443)"
 	@echo "  make ENABLE_TLS=1 ENABLE_HTTPS=1                            # TLS + HTTPS web (port 443)"
 	@echo "  make ENABLE_TLS=1 ENABLE_SSH=1                              # TLS + SSH shell (port 22)"

…olfHAL/boards/stm32h563zi_nucleo/board.c …32h563/boards/stm32h563zi_nucleo/board.csrc/port/wolfHAL/boards/stm32h563zi_nucleo/board.c renamed to src/port/stm32h563/boards/stm32h563zi_nucleo/board.c src/port/wolfHAL/boards/stm32h563zi_nucleo/board.c renamed to src/port/stm32h563/boards/stm32h563zi_nucleo/board.c

@@ -78,16 +78,6 @@ uint8_t ethTxBufs[BOARD_ETH_TX_DESC_COUNT * BOARD_ETH_TX_BUF_SIZE]
 uint8_t ethRxBufs[BOARD_ETH_RX_DESC_COUNT * BOARD_ETH_RX_BUF_SIZE]
     __attribute__((aligned(4)));
 
-/* UART: USART3 on the ST-Link VCP (caller-allocated, multi-instance driver) */
-whal_Uart g_whalUart = {
-    .base = WHAL_STM32H563_USART3_BASE,
-    /* .driver: direct API mapping */
-    .cfg = &(whal_Stm32h5_Uart_Cfg) {
-        .brr = WHAL_STM32H5_UART_BRR(168000000, 115200),
-        .timeout = &g_whalTimeout,
-    },
-};
-
 /*
  * FLASH_ACR (0x40022000): LATENCY[3:0] = 5 wait states for 168 MHz,
  * WRHIGHFREQ[5:4] = 2. Must be set before raising the clock.
@@ -159,7 +149,7 @@ whal_Error board_init(void)
     if (err)
         return err;
 
-    err = whal_Uart_Init(&g_whalUart);
+    err = whal_Uart_Init(WHAL_INTERNAL_DEV);
     if (err)
         return err;
 
@@ -211,7 +201,7 @@ whal_Error board_deinit(void)
     if (err)
         return err;
 
-    err = whal_Uart_Deinit(&g_whalUart);
+    err = whal_Uart_Deinit(WHAL_INTERNAL_DEV);
     if (err)
         return err;
 

…olfHAL/boards/stm32h563zi_nucleo/board.h …32h563/boards/stm32h563zi_nucleo/board.hsrc/port/wolfHAL/boards/stm32h563zi_nucleo/board.h renamed to src/port/stm32h563/boards/stm32h563zi_nucleo/board.h src/port/wolfHAL/boards/stm32h563zi_nucleo/board.h renamed to src/port/stm32h563/boards/stm32h563zi_nucleo/board.h

@@ -30,21 +30,19 @@
 #include <wolfHAL/platform/st/stm32h563xx.h>
 #include <wolfHAL/eth_phy/lan8742a_eth_phy.h>
 
-/* Caller-allocated devices (multi-instance drivers). */
-extern whal_Uart g_whalUart;
-
 extern whal_Timeout g_whalTimeout;
 extern volatile uint32_t g_tick;
 
-/* The generic wolfIP port (main.c, wolfhal_eth.c) references the board's
- * Ethernet, PHY, and RNG devices through these names. Under the current
- * wolfHAL API these are single-instance drivers whose device structs live
- * in the driver translation units (built from the WHAL_CFG_*_DEV
+/* The generic wolfIP port (main.c, wolfhal_eth.c, syscalls.c) references the
+ * board's Ethernet, PHY, RNG, and UART devices through these names. Under the
+ * current wolfHAL API these are single-instance drivers whose device structs
+ * live in the driver translation units (built from the WHAL_CFG_*_DEV
  * initializers below), so we alias the documented g_whal* names onto those
- * driver singletons. */
+ * driver-owned device structs. */
 #define g_whalEth     (*(whal_Eth *)&whal_Stm32h5_Eth_Dev)
 #define g_whalEthPhy  (*(whal_EthPhy *)&whal_Lan8742a_Dev)
 #define g_whalRng     (*(whal_Rng *)&whal_Stm32h5_Rng_Dev)
+#define g_whalUart    (*(whal_Uart *)&whal_Stm32h5_Uart_Dev)
 
 /* Ethernet PHY: LAN8742A on MDIO address 0 */
 #define BOARD_ETH_PHY_ADDR 0
@@ -64,7 +62,7 @@ enum {
     PIN_COUNT,
 };
 
-/* GPIO dev initializer — singleton defined in the gpio driver TU.
+/* GPIO dev initializer — device struct defined in the gpio driver code.
  * Only the USART3 (ST-Link VCP) and Ethernet RMII pins are configured. */
 #define WHAL_CFG_STM32H5_GPIO_DEV { \
     .base = WHAL_STM32H563_GPIO_BASE, \
@@ -121,17 +119,29 @@ enum {
     }, \
 }
 
-/* RNG dev initializer — singleton defined in the rng driver TU. */
+/* RNG dev initializer — device struct defined in the rng driver code. */
 #define WHAL_CFG_STM32H5_RNG_DEV { \
     .base = WHAL_STM32H563_RNG_BASE, \
     .cfg  = (void *)&(const whal_Stm32h5_Rng_Cfg){ \
         .timeout = &g_whalTimeout, \
     }, \
 }
 
+/* UART dev initializer — device struct defined in the UART driver code. Named
+ * WHAL_CFG_STM32WB_UART_DEV (not _STM32H5_) because the STM32H5 USART reuses
+ * the shared STM32WB UART driver, which instantiates the device from that
+ * exact name. USART3 on the ST-Link VCP; BRR for PCLK 168 MHz @ 115200. */
+#define WHAL_CFG_STM32WB_UART_DEV { \
+    .base = WHAL_STM32H563_USART3_BASE, \
+    .cfg  = (void *)&(const whal_Stm32h5_Uart_Cfg){ \
+        .brr = WHAL_STM32H5_UART_BRR(168000000, 115200), \
+        .timeout = &g_whalTimeout, \
+    }, \
+}
+
 /* ETH descriptor rings + buffer pool — defined in board.c, captured by the
- * ETH singleton's cfg below (expanded in the eth driver TU). */
-#define BOARD_ETH_TX_DESC_COUNT 4
+ * ETH device's cfg below (expanded in the eth driver code). */
+#define BOARD_ETH_TX_DESC_COUNT 3
 #define BOARD_ETH_RX_DESC_COUNT 4
 #define BOARD_ETH_TX_BUF_SIZE   1536
 #define BOARD_ETH_RX_BUF_SIZE   1536
@@ -145,7 +155,7 @@ extern uint8_t ethRxBufs[BOARD_ETH_RX_DESC_COUNT * BOARD_ETH_RX_BUF_SIZE];
 #define BOARD_MAC_ADDR {0x00, 0x80, 0xE1, 0x00, 0x00, 0x01}
 #endif
 
-/* ETH dev initializer — singleton defined in the eth driver TU. */
+/* ETH dev initializer — device struct defined in the eth driver code. */
 #define WHAL_CFG_STM32H5_ETH_DEV { \
     .base    = WHAL_STM32H563_ETH_BASE, \
     .macAddr = BOARD_MAC_ADDR, \
@@ -163,7 +173,7 @@ extern uint8_t ethRxBufs[BOARD_ETH_RX_DESC_COUNT * BOARD_ETH_RX_BUF_SIZE];
     }, \
 }
 
-/* LAN8742A PHY dev initializer — singleton defined in the phy driver TU. */
+/* LAN8742A PHY dev initializer — device struct defined in the phy driver code. */
 #define WHAL_CFG_LAN8742A_DEV { \
     .eth  = NULL, \
     .addr = BOARD_ETH_PHY_ADDR, \
@@ -172,7 +182,7 @@ extern uint8_t ethRxBufs[BOARD_ETH_RX_DESC_COUNT * BOARD_ETH_RX_BUF_SIZE];
     }, \
 }
 
-/* SysTick dev initializer — singleton defined in the systick driver TU. */
+/* SysTick dev initializer — device struct defined in the systick driver code. */
 #define WHAL_CFG_SYSTICK_DEV { \
     .base = WHAL_CORTEX_M33_SYSTICK_BASE, \
     .cfg  = (void *)&(const whal_SysTick_Cfg){ \

src/port/stm32h563/boards/stm32h563zi_nucleo/board.mk

@@ -0,0 +1,31 @@
+# wolfHAL-specific build settings for the STM32H563ZI Nucleo board.
+#
+# Included by the port Makefile only when ENABLE_WOLFHAL=1. The port
+# Makefile owns the toolchain, base CFLAGS, include paths, and linker
+# script; this fragment contributes only the wolfHAL driver selection
+# and the wolfHAL driver translation units. WOLFHAL_ROOT is set by the
+# port Makefile.
+
+# Direct-API-mapping driver selection: one concrete driver TU per domain,
+# no generic dispatch layer (which would redefine the top-level symbols).
+CFLAGS += -DPLATFORM_STM32H5
+CFLAGS += -DWHAL_CFG_STM32H5_GPIO_DIRECT_API_MAPPING
+CFLAGS += -DWHAL_CFG_STM32H5_RCC_PLL_DRIVER
+CFLAGS += -DWHAL_CFG_STM32H5_RCC_DIRECT_API_MAPPING
+CFLAGS += -DWHAL_CFG_STM32H5_UART_DIRECT_API_MAPPING
+CFLAGS += -DWHAL_CFG_STM32H5_UART_SINGLE_INSTANCE
+CFLAGS += -DWHAL_CFG_STM32H5_RNG_DIRECT_API_MAPPING
+CFLAGS += -DWHAL_CFG_STM32H5_ETH_DIRECT_API_MAPPING
+CFLAGS += -DWHAL_CFG_LAN8742A_ETH_PHY_DIRECT_API_MAPPING
+CFLAGS += -DWHAL_CFG_STM32H5_FLASH_DIRECT_API_MAPPING
+CFLAGS += -DWHAL_CFG_SYSTICK_TIMER_DIRECT_API_MAPPING
+
+# wolfHAL driver translation units. Built with relaxed warnings via the
+# port Makefile's $(WOLFHAL_ROOT)/%.o rule.
+SRCS += $(WOLFHAL_ROOT)/src/reg.c
+SRCS += $(WOLFHAL_ROOT)/src/eth/stm32h5_eth.c
+SRCS += $(WOLFHAL_ROOT)/src/eth_phy/lan8742a_eth_phy.c
+SRCS += $(WOLFHAL_ROOT)/src/gpio/stm32h5_gpio.c
+SRCS += $(WOLFHAL_ROOT)/src/uart/stm32h5_uart.c
+SRCS += $(WOLFHAL_ROOT)/src/rng/stm32h5_rng.c
+SRCS += $(WOLFHAL_ROOT)/src/timer/systick.c

…/wolfHAL/boards/stm32h563zi_nucleo/ivt.c …tm32h563/boards/stm32h563zi_nucleo/ivt.csrc/port/wolfHAL/boards/stm32h563zi_nucleo/ivt.c renamed to src/port/stm32h563/boards/stm32h563zi_nucleo/ivt.c src/port/wolfHAL/boards/stm32h563zi_nucleo/ivt.c renamed to src/port/stm32h563/boards/stm32h563zi_nucleo/ivt.c

@@ -25,9 +25,9 @@
 #include <stdint.h>
 #include <stddef.h>
 #include <wolfHAL/uart/uart.h>
+#include "board.h"   /* g_whalUart singleton alias (single-instance UART) */
 extern uint32_t _ebss;
 extern uint32_t _heap_limit;
-extern whal_Uart g_whalUart;
 
 static char *heap_end;