GHMiranda
/
YMF262_devboard_Firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md with testing instructions and some grammar improvements

This commit is contained in:
Gustavo Henrique Santos Souza de Miranda 2026-06-03 12:32:22 -03:00
parent 2172ed0735
commit 17b754c864
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -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 ## Building
@ -14,6 +14,22 @@ To build a Flashable .elf file issue the following commands:
```cmake --preset Release && cmake --build --preset Release``` ```cmake --preset Release && cmake --build --preset Release```
## Flashing: ## 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"``` ```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).
````