Skip to content

Commit c758145

Browse files
Added screenshots and initial content for FPGA input section (#270)
1 parent 95c5fe1 commit c758145

File tree

1 file changed

+59
-9
lines changed

1 file changed

+59
-9
lines changed

docs/source/user_guide/FPGA_index.rst

Lines changed: 59 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,79 @@
22
FPGA Input
33
=============
44

5-
This section will document FPGA input for Rapid Power Estimator.
5+
6+
To begin inputting FPGA information, the user must have an RTL design that they would like to run on an FPGA platform. For users who have used other FPGA vendors' EDA tools, they can directly enter the FPGA input using their estimated FPGA utilization.
7+
8+
For new FPGA users, we reccommend first running their RTL design on Raptor Design Suite. Raptor will provide the user with a utilization report to help fill out RPE's FPGA input sections.
69

710
Clocking
811
#########
912

13+
The clocking section is located on the top left of the FPGA input section.
14+
15+
.. image:: figures/FPGA-figures-clocking-clocking_selected.JPG
16+
17+
Selecting the clocking section will display an empty table, click the "Add" button above the table to fill out clock information.
18+
1019
.. image:: figures/FPGA-figures-clocking-input_clock_info.JPG
11-
:width: 300px
12-
:align: center
13-
:height: 350px
14-
:alt: Setup Diagram
1520

16-
.. image:: FPGA/figures/clocking-input_clock_info.JPG
17-
:alt: Setup Diagram
18-
:align: center
21+
Select the clock source using the source dropdown, then provide a description (optional) and name for the clock. Enter the clock frequency and lastly it's state. Repeat the following steps for each clock used in the RTL design.
1922

2023
FLE - Functional Logic Element
2124
###############################
2225

26+
The FLE section is located on the top right of the FPGA input section.
27+
28+
.. image:: figures/FPGA-figures-FLE-FLE_selected.JPG
29+
30+
Selecting the FLE section displays an empty table, click the "Add" button above the table to fill out the FLE info.
31+
32+
.. image:: figures/FPGA-figures-FLE-input_FLE_info.JPG
33+
34+
Enter the no. of LUTs & flip-flops, then select the main clock from the clock dropdown. Lastly enter toggle rate, glitch factor and clock enable rate.
35+
2336
BRAM - Block Randon Access Memory
2437
##################################
2538

39+
The BRAM section is located directly below the clocking section.
40+
41+
.. image:: figures/FPGA-figures-BRAM-BRAM_selected.JPG
42+
43+
Selecting the BRAM section displays an empty table, click the "Add" button above the table to fill out the BRAM info.
44+
45+
.. image:: figures/FPGA-figures-BRAM-input_BRAM_info.JPG
46+
47+
.. image:: figures/FPGA-figures-BRAM-input_BRAM_ports_info.JPG
48+
49+
Select the type of BRAM used on the RTL design, then the no. of that type of BRAM used.
50+
51+
Next fill out the read & write ports info. For each, select the clock, enter port width and senter write enable, read enable as well as toggle rates.
52+
2653
DSP - Digital Signal Processor
2754
###############################
2855

56+
The DSP section is located directly below the FLE section.
57+
58+
.. image:: figures/FPGA-figures-DSP-DSP_selected.JPG
59+
60+
Selecting the DSP section displays an empty table, click the "Add" button above the table to fill out the DSP info.
61+
62+
.. image:: figures/FPGA-figures-DSP-input_DSP_info.JPG
63+
64+
Ener the no. of DSP multipliers used, select the DSP's mode, enter channel width for all inputs, select a clock, then select the pipeline type and enter toggle rate.
65+
2966
IO - Input/Output
30-
##################
67+
##################
68+
69+
The IO section is located the botton of the FPGA input section.
70+
71+
.. image:: figures/FPGA-figures-IO-IO_selected.JPG
72+
73+
Selecting the IO section displays an empty table, click the "Add" button above the table to fill out the IO info.
74+
75+
.. image:: figures/FPGA-figures-IO-input_IO_info1.JPG
76+
77+
.. image:: figures/FPGA-figures-IO-input_IO_info2.JPG
78+
79+
Enter I/O port name, bus width, select clock, enter duty cycle, select IO direction & standard, drive strength (current in Amperes), slew rate, differential termination, pullup/pulldown resistors, data type, enter input enable rate, output enable rate, select synchronization & enter toggle rate
80+

0 commit comments

Comments
 (0)