readme: init

This commit is contained in:
occheung 2020-08-07 13:04:39 +08:00
commit 778a452425
1 changed files with 46 additions and 0 deletions

46
README.md Normal file
View File

@ -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 <filename>
```
Leave <filename> as blank for default openocd.gdb configuration.