commit 778a452425663e7f67eceb31fc32c6ae2470e643 Author: occheung Date: Fri Aug 7 13:04:39 2020 +0800 readme: init diff --git a/README.md b/README.md new file mode 100644 index 0000000..03801a9 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Firmware development + +RF signal generator using Urukul, Humpback and STM32 + +## Nix commands + +Open nix shell before anything. +```bash +nix-shell +``` + +Start OpenOCD server in unblocking mode. +```bash +run-openocd +``` + +Start OpenOCD server in blocking mode, for console print through semihosting. +```bash +run-openocd-block +``` + +Reset STM32 flash before flashing bitstream for Humpback FPGA. +```bash +reset-flash +``` + +Load bitstream to Humpback FPGA. +```bash +configure-fpga +``` + +Verify a proper bitstream is loaded to STM32 flash. +```bash +verify-fpga-config +``` + +Run a Ethernet server with TCP socket examples. +```bash +run-ethernet-server +``` + +Select a different gdb config file from ```gdb_config``` directory. +```bash +set-gdb-config-file +``` +Leave as blank for default openocd.gdb configuration.