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
|
|
|
|
|
|
2024-02-04 12:00:35 -05:00
|
|
|
* [boot](boot/): This folder is the central place for all built files. This
|
2023-06-27 13:24:26 -04:00
|
|
|
includes the kernel image, rootfs, gateware, etc. This directory also
|
|
|
|
|
includes everything the TFTP server has to access.
|
2024-02-04 12:00:35 -05:00
|
|
|
* [build](build/): Docker build environment.
|
|
|
|
|
* [buildroot](buildroot/): Buildroot configuration files.
|
|
|
|
|
* [doc](doc/): Documentation.
|
|
|
|
|
* [doc/copying](doc/copying/): Licenses.
|
|
|
|
|
* [gateware](gateware/): FPGA source.
|
|
|
|
|
* [gateware/rtl](gateware/rtl/): Verilog sources.
|
|
|
|
|
* [gateware/rtl/spi](gateware/rtl/spi/): SPI code (from another repo)
|
|
|
|
|
* [linux](linux/): Software that runs on the controller.
|
|
|
|
|
* [opensbi](opensbi/): OpenSBI configuration files and source fragments.
|
|
|
|
|
* [swic](swic/): Code that runs on the PicoRV32 soft core.
|
