copilot: Add hello world example for FPGA. Refs #657.
#658
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RyanGlScott
reviewed
Aug 22, 2025
| The main Copilot specification is created in a file `HelloWorld.hs`. The final | ||
| contents of | ||
| [HelloWorld.hs](https://github.com/Copilot-Language/copilot/tree/master/copilot/examples/fpga/HelloWorld/HelloWorld.hs) | ||
| is available in the [examples/fpga |
There was a problem hiding this comment.
Perhaps this should be:
Suggested change
| is available in the [examples/fpga | |
| is available in the [`examples/fpga/HelloWorld` |
Comment on lines
+143
to
+156
| of the repository. The directory contains several examples, as well as any | ||
| auxiliary files needed to run the code onto an FPGA board. |
There was a problem hiding this comment.
This says that the directory contains several examples, but I only see a single example (HelloWorld).
| ``` | ||
|
|
||
| In the above trigger definition, `"leds"` is the name of the output, whereas | ||
| `leds` is an internal Copilot entity that, at each point in time will contain |
There was a problem hiding this comment.
Calling leds "internal" is perhaps a bit misleading, as it is wholly possible to observe the value of the leds stream using the Copilot interpreter. Perhaps we should just say "leds is a Copilot stream that [...]".
Comment on lines
+338
to
+351
| `mkTop.v` is successfully created in your current directory. To program the | ||
| code onto the FPGA, the ports declarations and assignments need modifications. |
There was a problem hiding this comment.
My hope is that after #654 is implemented upstream, we will no longer need to make modifications to the generated Verilog code. (This isn't a review suggestion so much as it is a TODO for myself.)
| `mkTop.v` is successfully created in your current directory. To program the | ||
| code onto the FPGA, the ports declarations and assignments need modifications. | ||
|
|
||
| In our `Top.bs`, the module that had the register and interface for the leds |
There was a problem hiding this comment.
Suggested change
| In our `Top.bs`, the module that had the register and interface for the leds | |
| In our `Top.bs`, the module that had the register and interface for the LEDs |
| edge of the `CLK`. | ||
|
|
||
| Replace / add the following lines mentioned above. For reference, the complete | ||
| contents of mkTop.v after applying the changes are included below. |
There was a problem hiding this comment.
Suggested change
| contents of mkTop.v after applying the changes are included below. | |
| contents of `mkTop.v` after applying the changes are included below. |
|
|
||
| Once installed, open your Vivado Design Suite. | ||
|
|
||
| 1. Click `Create Project` > `Next` > Project Name : `HelloWorld` and choose the |
There was a problem hiding this comment.
Suggested change
| 1. Click `Create Project` > `Next` > Project Name : `HelloWorld` and choose the | |
| 1. Click `Create Project` > `Next` > `Project Name` : `HelloWorld` and choose the |
| `Open Target` > Plug in your FPGA board via USB. > `Auto Connect` > `Program | ||
| Device`. | ||
|
|
||
| The LEDS on your FPGA board should now display the LEDS counting up in |
There was a problem hiding this comment.
Suggested change
| The LEDS on your FPGA board should now display the LEDS counting up in | |
| The LEDS on your FPGA board should now display the LEDs counting up in |
We need an example that demonstrates how to work with FPGAs using Copilot. This will help users start with copilot-bluespec, and also help validate our work. This commit adds a hello world example that demonstrates how to control 4 LEDs from 4 switches. The tutorial describes how to install Vivado, create the spec, compile it (in bluespec and then verilog), and upload it to the board.
sukhmankkahlon
force-pushed
the
develop-examples-fpga-helloworld
branch
from
22e142a to
24840c0
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce a new hello world example for FPGA with instructions in a README and all necessary auxiliary files, as prescribed in the solution proposed for #657.