From 17b754c8641b8aeb6cb6a1a25a0c55b9067ded00 Mon Sep 17 00:00:00 2001 From: Gustavo Henrique Santos Souza de Miranda Date: Wed, 3 Jun 2026 12:32:22 -0300 Subject: [PATCH] Update README.md with testing instructions and some grammar improvements --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 55050fc..32e63d0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# YMF-262 Firmware for Nucleo F722RE Board and STM32F7 MCU +# YMF-262 Firmware for Nucleo F722ZE Board and STM32F7 MCU ## Building @@ -14,6 +14,22 @@ To build a Flashable .elf file issue the following commands: ```cmake --preset Release && cmake --build --preset Release``` ## Flashing: -To flash the .elf file please issue the folowing command: +To flash the .elf file please issue the following command: -```openocd -f interface/stlink.cfg -f target/stm32f7x.cfg -c "program YMF262_Devboard_Firmware.elf verify reset exit"``` \ No newline at end of file +```openocd -f interface/stlink.cfg -f target/stm32f7x.cfg -c "program YMF262_Devboard_Firmware.elf verify reset exit"``` + +## Testing + +The HAL logic is unit-tested on the host (x86) using GoogleTest, with a `FakeGpio` mock that records the GPIO operations instead of touching hardware. This verifies the YMF262 write choreography (two-cycle address/data sequence and timing) without needing the physical chip. + +To build and run the tests: + +````cd Tests + cmake -B build + cmake --build build + ./build/run_tests``` + +GoogleTest is fetched automatically via CMake FetchContent on the first configure (requires internet). +```` + +