README.md

# Gonk

[TOC]

## Getting Started

1. Clone the repo

   ```sh
   git clone https://pigweed.googlesource.com/pigweed/gonk
   ```

2. Source `bootstrap.sh` to download all compilers and tooling into the
   `environment` directory:

   ```sh
   . ./bootstrap.sh
   ```

   This should init all git submodules for you.

3. From here on the Pigweed environment is activated. You can activate the
   environment in a new shell without re-running bootstrap by sourcing
   `activate.sh`

   ```sh
   . ./activate.sh
   ```

## Compile:

Build for the host and device by running:

```sh
pw build
```

This is mostly a shortcut with nice output for running `gn gen out/gn` and
`ninja -C out/gn`.

The build commands are defined in: `//tools/gonk_tools/build_project.py`.

## Gonk Verilog:

The Verilog build requires the following to be installed on Linux:

```sh
sudo apt install fpga-icestorm nextpnr-ice40 yosys
```

Run this to compile:

```sh
pw build
```

The bitstream files will be written with the `.bin` extenson under
`./out/gn/obj/fpga/*/*.bin` along with log output files.

For example:

```sh
$ ls ./out/gn/obj/fpga/toplevel/
nextpnr-log.txt
toplevel.asc
toplevel.bin
toplevel.json
toplevel_timing_report.json
toplevel_timing_report.txt
yosys-log.txt
```

## Gonk fpga config Example

Flash the stm32f7 and launch the `write_fpga.py` script on a bitstream file.

### Flash with dfu-util

1. Unplug gonk from USB and replug with MODE button held down.

1. Run `pw flash` on the MCU binary.

   ```sh
   pw flash ./out/gn/arduino_size_optimized/obj/applications/fpga_config/fpga_config.bin
   ```

### Write the FPGA bitstream

1. Write an FPGA bitstream with the `write_fpga.py` script:

   ```sh
   python ./tools/gonk_tools/write_fpga.py \
     --bitstream-file ./out/gn/obj/fpga/toplevel/toplevel.bin
     --database ./out/gn/arduino_size_optimized/obj/applications/fpga_config/bin/fpga_config.elf \
     --log-to-stderr
   ```

   You can redirect host and device logs to separate files with:

   ```sh
   python ./tools/gonk_tools/write_fpga.py \
     --bitstream-file ./out/gn/obj/fpga/toplevel/toplevel.bin
     --database ./out/gn/arduino_size_optimized/obj/applications/fpga_config/bin/fpga_config.elf \
     --host-logfile gonk-host-logs.txt \
     --device-logfile gonk-device-logs.txt
   ```

### Alternative: Flash with BlackMagic Probe

```sh
./scripts/flash-with-blackmagic-probe.sh ./out/gn/arduino_size_optimized/obj/applications/spi_flash_test/bin/spi_flash_test.elf
```

## Generating the Gonk Python Bundle

On Linux with the FPGA toolchain available run:

```sh
pw build
```

The zip file containing all the dependencies for the gonk python tooling is located in:

```sh
out/gn/obj/gonk_bundle.zip
```

Inside are the Python wheels for `gonk_dist`, `gonk_firmware`, and all
third_party dependencies.

```
gonk_bundle
├── python_wheels
│   ├── appdirs-1.4.4-py2.py3-none-any.whl
│   ├── astroid-3.0.1-py3-none-any.whl
│   ├── ...
│   ├── gonk_dist-0.0.1+20240305140627-py3-none-any.whl
│   ├── gonk_firmware-0.0.1+20240305140542-py3-none-any.whl
│   ├── ...
│   └── wheel-0.40.0-py3-none-any.whl
├── requirements.txt
├── setup.bat
└── setup.sh
```

## pw_system Example

### Run on Host

Run the host app and connect to it via `pw-system-console`:

```sh
./out/gn/host_device_simulator.speed_optimized/obj/applications/system_example/bin/system_example & \
  pw-system-console --socket-addr default \
    --proto-globs third_party/pigweed/pw_rpc/echo.proto ; \
  killall system_example
```

### Run on Device

Flashing

```sh
openocd -s $PW_PIGWEED_CIPD_INSTALL_DIR/share/openocd/scripts \
  -f $GONK_ROOT/targets/stm32f769i_disc0_stm32cube/openocd_stm32f7xx.cfg \
  -c "program out/gn/stm32f769i_disc0_stm32cube.size_optimized/obj/applications/system_example/bin/system_example.elf reset exit"
```

## Updating STM32Cube

Checkout the desired commits in each of these submodules:

```
third_party/stm32cube_f7/cmsis_core
third_party/stm32cube_f7/cmsis_device
third_party/stm32cube_f7/hal_driver
```

Then run from Gonk root:

```sh
python -m pw_stm32cube_build gen_file_list third_party/stm32cube_f7
```

# Pin Map

## Misc

| Net    | STM32 Pin | STM32 Function | Function |
|--------|-----------|----------------|----------|
| STATUS | PB13      | GPIO_Output    | STAT LED |

## SPI Flash Connection

| Net          | FPGA IO# | STM32 Pin | STM32 Function | Flash Pin  |
|--------------|----------|-----------|----------------|------------|
| ICE_SPI_SS   |       71 | PD2       | GPIO_Output    | S#         |
| ICE_SPI_MISO |       68 | PB4       | SPI1_MISO      | DQ1        |
| ICE_SPI_MOSI |       67 | PB5       | SPI1_MOSI      | DQ0        |
| ICE_SPI_SCK  |       70 | PB3       | SPI1_SCK       | C          |
| FLASH_HOLD   |       63 | PC11      | GPIO_Output    | HOLD#/DQ3  |
| FLASH_WP     |       64 | PC12      | GPIO_Output    | W#/VPP/DQ2 |

## FPGA Connection

| Net               | Function | FPGA IO# | STM32 Pin | STM32 Function | Notes               |
|-------------------|----------|----------|-----------|----------------|---------------------|
| FPGA_IO_SPARE_0_2 | rst_i    |      135 | PA0       | GPIO_Output    | Active high         |
| FPGA_IO_SPARE_0_0 | mode_i   |      137 | PB11      | GPIO_Output    | FPGA operation mode |
| DSPI_CS           | valid_o  |       75 | PB6       | GPIO_Output    | Data/Transfer Valid |
| FPGA_IO_SPARE_1_1 | miso_i   |      101 | PC2       | SPI1_MISO      |                     |
| FPGA_IO_SPARE_1_0 | mosi_i   |       99 | PC3       | SPI1_MOSI      |                     |
| I2C_O_SDA         | cs_n     |       79 | PB9       | SPI1_NSS       |                     |
| FPGA_IO_SPARE_0_1 | sclk_i   |      136 | PB10      | SPI1_SCK       |                     |
| FPGA_IO_SPARE_2_0 |          |       49 | PA7       |                |                     |
| FPGA_IO_SPARE_2_1 |          |       48 | PA6       |                |                     |
| FPGA_IO_SPARE_2_2 |          |       47 | PA5       |                |                     |
| FPGA_IO_SPARE_2_3 |          |       45 | PA4       |                |                     |