mirror of
https://github.com/im-tomu/fomu-workshop.git
synced 2024-09-20 03:10:12 +00:00
Merge pull request #388 from juanmard/icestudio/add-module-screenshots
doc: add IceStudio module navigation screenshots.
This commit is contained in:
commit
57ea1a77c3
BIN
docs/_static/icestudio/blinky.gif
vendored
Normal file
BIN
docs/_static/icestudio/blinky.gif
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 7.3 MiB |
BIN
docs/_static/icestudio/blinky_diagram.png
vendored
Normal file
BIN
docs/_static/icestudio/blinky_diagram.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 61 KiB |
BIN
docs/_static/icestudio/clk_buffering.png
vendored
Normal file
BIN
docs/_static/icestudio/clk_buffering.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 21 KiB |
BIN
docs/_static/icestudio/pwm_generator.png
vendored
Normal file
BIN
docs/_static/icestudio/pwm_generator.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 30 KiB |
BIN
docs/_static/icestudio/sb_rgba_drv.png
vendored
Normal file
BIN
docs/_static/icestudio/sb_rgba_drv.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 34 KiB |
@ -21,7 +21,7 @@ Moreover, ``Blinky_BoardTop.ice`` wraps Blinky, showcasing how
|
|||||||
to use the Design Under Test (DUT) as a black box.
|
to use the Design Under Test (DUT) as a black box.
|
||||||
|
|
||||||
Open ``Blinky_BoardTop.ice`` from `Icestudio <https://juanmard.github.io/icestudio/>`_
|
Open ``Blinky_BoardTop.ice`` from `Icestudio <https://juanmard.github.io/icestudio/>`_
|
||||||
and use the buttons on the botton:
|
and use the buttons at the botton:
|
||||||
|
|
||||||
.. image:: _static/icestudio/blinky_steps.png
|
.. image:: _static/icestudio/blinky_steps.png
|
||||||
:width: 600 px
|
:width: 600 px
|
||||||
@ -31,12 +31,15 @@ and use the buttons on the botton:
|
|||||||
0. Check that the **selected board** is the Fomu.
|
0. Check that the **selected board** is the Fomu.
|
||||||
|
|
||||||
- Click on the button with a 'microchip' icon, and a modal window will open.
|
- Click on the button with a 'microchip' icon, and a modal window will open.
|
||||||
- There, select the device (UP5K) in the first dropdown list and the board (Fomu) in the second list.
|
- There, select the device (UP5K) in the first dropdown list and the board (Fomu)
|
||||||
|
in the second list.
|
||||||
|
|
||||||
1. Click on the **Verify** button for checking the design.
|
1. Click on the **Verify** button for checking the design.
|
||||||
2. Click on the **Build** button for having the design exported to Verilog, synthesised, placed, routed and, finally, the bitstream generated.
|
2. Click on the **Build** button for having the design exported to Verilog, synthesised,
|
||||||
|
placed, routed and, finally, the bitstream generated.
|
||||||
3. Click on the **Upload** for sending the bitstream to the board.
|
3. Click on the **Upload** for sending the bitstream to the board.
|
||||||
4. After each of the steps is executed, the corresponding log can be shown through button **View command output**.
|
4. After each of the steps is executed, the corresponding log can be shown through button
|
||||||
|
**View command output**.
|
||||||
|
|
||||||
You should see the rainbow pattern in the Fomu as soon as the *Upload*
|
You should see the rainbow pattern in the Fomu as soon as the *Upload*
|
||||||
step is finished:
|
step is finished:
|
||||||
@ -46,17 +49,42 @@ step is finished:
|
|||||||
:align: center
|
:align: center
|
||||||
:target: https://github.com/juanmard/icestudio
|
:target: https://github.com/juanmard/icestudio
|
||||||
|
|
||||||
However, that's just the beginning of the trip. You
|
However, that's just the beginning of the trip...
|
||||||
can navigate the hierarchy of the designs by double-clicking on the main
|
|
||||||
|
Navigation
|
||||||
|
==========
|
||||||
|
|
||||||
|
You can navigate the hierarchy of the design by double-clicking on the main
|
||||||
block. Go as deep as you want, until you find raw Verilog code. As you
|
block. Go as deep as you want, until you find raw Verilog code. As you
|
||||||
can observe, ICE modules are fancy wrappers around the Verilog code from
|
can observe, ICE modules are fancy wrappers around the Verilog code from
|
||||||
``verilog/blink``.
|
``verilog/blink``.
|
||||||
|
|
||||||
|
.. image:: _static/icestudio/blinky.gif
|
||||||
|
:width: 600 px
|
||||||
|
:align: center
|
||||||
|
|
||||||
Editing submodules is blocked by default, but you can unlock the feature
|
Editing submodules is blocked by default, but you can unlock the feature
|
||||||
with the red button on the botton left. Do the modifications you wish,
|
with the red button at the botton left. Do the modifications you wish,
|
||||||
then save the changes and go back to the top. There is a 'Home' button
|
then save the changes and go back to the top. There is a 'Home' button
|
||||||
on the bottom left for jumping to the root of the design straightaway.
|
at the bottom left for jumping to the root of the design straightaway.
|
||||||
From the top, you can verify, build and upload the design again.
|
From the top, you can verify, build and upload the design again.
|
||||||
|
|
||||||
Find more info about features of IceStudio (such as collections or
|
You can also open or save each of the blocks as an independent project.
|
||||||
plugins) in the `documentation <https://juanmard.github.io/icestudio/index.html>`_.
|
For instance, open ``Blinky.ice``, instead of ``Blinky_BoardTop.ice``:
|
||||||
|
|
||||||
|
.. image:: _static/icestudio/blinky_diagram.png
|
||||||
|
:width: 600 px
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
Modules are browsable, as shown in the screencast above:
|
||||||
|
|
||||||
|
.. image:: _static/icestudio/clk_buffering.png
|
||||||
|
:width: 33%
|
||||||
|
.. image:: _static/icestudio/pwm_generator.png
|
||||||
|
:width: 33%
|
||||||
|
.. image:: _static/icestudio/sb_rgba_drv.png
|
||||||
|
:width: 33%
|
||||||
|
|
||||||
|
.. HINT:: Find more info about features of IceStudio (such as collections or
|
||||||
|
plugins) in the `documentation <https://juanmard.github.io/icestudio/index.html>`_.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user