2022-09-17 00:35:47 -04:00
|
|
|
# upsilon
|
|
|
|
|
|
2023-06-14 15:13:16 -04:00
|
|
|
Upsilon is a 100% free and open source STM/AFM controller for FPGAs running
|
2023-08-15 17:58:03 -04:00
|
|
|
Linux. Read [doc/copying/README.md](doc/copying/README.md) for license information.
|
2022-09-17 00:35:47 -04:00
|
|
|
|
2023-06-27 13:24:26 -04:00
|
|
|
## Quickstart
|
2022-09-17 00:35:47 -04:00
|
|
|
|
2023-08-15 17:59:14 -04:00
|
|
|
Read [doc/docker.md](doc/docker.md) to set up the Docker build environment.
|
2023-06-27 13:24:26 -04:00
|
|
|
|
|
|
|
|
## Project Organization
|
|
|
|
|
|
|
|
|
|
* `boot/`: This folder is the central place for all built files. This
|
|
|
|
|
includes the kernel image, rootfs, gateware, etc. This directory also
|
|
|
|
|
includes everything the TFTP server has to access.
|
|
|
|
|
* `build/`: Docker build environment.
|
|
|
|
|
* `buildroot/`: Buildroot configuration files.
|
|
|
|
|
* `doc/`: Documentation.
|
|
|
|
|
* `doc/copying`: Licenses.
|
|
|
|
|
* `gateware/`: FPGA source.
|
2023-06-28 17:38:41 -04:00
|
|
|
* `gateware/rtl`: Verilog sources.
|
|
|
|
|
* `gateware/rtl/control_loop`: Control loop code.
|
|
|
|
|
* `gateware/rtl/spi`: SPI code.
|
2023-06-27 13:24:26 -04:00
|
|
|
* `linux/`: Software that runs on the controller.
|
|
|
|
|
* `opensbi/`: OpenSBI configuration files and source fragments.
|
