The Documentation and Repository files are currently under the development and may change in the future.
| Dark Mode GUI | Light Mode GUI |
|---|---|
 |
 |
For building the application for production environment, use following command.
cargo build --releaseEven though the sudo crate is used to enable sudo mode when debugging the application (needed for access to serial ports) the following command is usefull when running the debug mode on your architecture.
CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_RUNNER='sudo -E -S' cargo watch -x runCARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_RUNNERis the platform as available at The rustc book - Platform Support, the reference of Environmental variables may be found at The Cargo Booksudo -E -S-Eflag is used to preserve the current user's environmental variables-Sflag (stdin) option causes sudo to read the password from stan-dard input instead of the terminal device.cargo watch -x runis command available when cargo watch is installed globally
For the TTL232R-3V3 device to be recognizable by macOS, the library libftd2xx.dylib must be installed. The installation must be probably done according to the readme file included in the downloaded dmg file of the library. After the installation, restart the machine and the FTDI device should be named as FTDI device and working.
Check the guide for macOS FTDI
Download drivers for FTDI devices
For behavioral simulation cocotb in conjuction with Verilator can be used. In fact, Verilator is set as the used simulator in Python cocotb files. The design for simulation purposes may be different from the design used for synthesizing to a GOWIN FPGA. The core elements are the same, but for the sake of simulation time, the frequency, input signals, etc. may differ.
In the future, there may be a merge of the folders containing code for simulation and synthesis. It would be good to unify all aspects of the design.
The waveforms generated waveforms then may be opened using GTKWave.
To perform simulation, navigate to fpga/sim/coco and check the Makefile for available commands. The recent one is make pytestMonit which runs the simulation for 'monit' module.
The simulation can be modified using corresponding Python file.
The design files modified for synthesis onto Gowin GW1NR-9 27 MHz SiPeed Tang Nano 9k board are available at fpga/gowin/comm/src. Whereas the project, which may be opened in Gowin EDA is located at fpga/gowin/comm/comm.gprj.
If the bitstream, generated from Gowin EDA cannot be loaded onto the FPGA, the openFPGALoader is recommended.
Load the bitstream to the board via following command.
sudo openFPGALoader -b tangnano9k comm.fswhere tangnano9k is your board. For further questions or issues please consult the openFPGALoader documentation.
Contributions are greatly appreciated! Just fork the repository, submit an issue or create PR!
Feedback is also welcome! Please submit an issue or contact our core maintainers.
