Skip to content

Commit 2dbf7bb

Browse files
committed
readme: updated readme to better reflect current functionality
1 parent 9cecb32 commit 2dbf7bb

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,20 @@
66
This command-line tool converts [FASM][fasm-spec] files into bitstreams, simplifying the assembly of human-readable FPGA configurations into the binary formats needed to program various FPGAs.
77

88
At this stage, it can generate a set of frames in the same manner as [fasm2frames](https://github.com/chipsalliance/f4pga-xc-fasm/blob/25dc605c9c0896204f0c3425b52a332034cf5e5c/xc_fasm/fasm2frames.py).
9-
It has been tested with the Artix-7 [counter example][counter-example], where it produces identical frames—at approximately 10 times the speed compared to the pure Python textX based parser implementation.
9+
It has been tested with the Artix-7 [counter example][counter-example], where it produces identical frames—at and a working bitstream at approximately 10 times the speed compared to the pure Python textX based parser implementation.
1010

1111
## Usage
1212

1313
First, install [Bazel][bazel] and ensure you have a basic C/C++ toolchain set up. Then run:
1414

1515
```
16-
bazel run -c opt //fpga:fpga-as -- --prjxray_db_path=/some/path/prjxray-db/artix7 --part=xc7a35tcsg324-1 < /some/path.fasm
16+
bazel run -c opt //fpga:fpga-as -- --prjxray_db_path=/some/path/prjxray-db/artix7 --part=xc7a35tcsg324-1 < /some/path.fasm > output.bit
17+
```
18+
19+
Finally, load the bitstream in your FPGA using [openFPGALoader][open-fpga-loader]
20+
21+
```
22+
openFPGALoader -b arty output.bit
1723
```
1824

1925
## Installation
@@ -59,3 +65,4 @@ Using this metadata, you can search the segbits database for the specific featur
5965
[fasm-spec]: https://fasm.readthedocs.io/en/stable/#
6066
[bazel]: https://bazel.build/
6167
[counter-example]: https://github.com/chipsalliance/f4pga-examples/blob/13f11197b33dae1cde3bf146f317d63f0134eacf/xc7/counter_test/counter.v
68+
[open-fpga-loader]: https://github.com/trabucayre/openFPGALoader

shell.nix

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ pkgs.mkShell {
3131
pprof
3232
perf_data_converter
3333
valgrind
34+
35+
# FPGA utils.
36+
openfpgaloader
3437
];
3538

3639
CLANG_TIDY="${clang_for_tidy}/bin/clang-tidy";

0 commit comments

Comments
 (0)