FPGA input fields, added explanation and defaults as well as fixed fe…

…w labels (#281)

docs/source/user_guide/FPGA_index.rst

@@ -2,6 +2,7 @@
 FPGA Input
 =============
 
+This section will document FPGA input for Rapid Power Estimator.
 
 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. 
 
@@ -14,24 +15,42 @@ The clocking section is located on the top left of the FPGA input section.
 
 .. image:: figures/FPGA-figures-clocking-clocking_selected.JPG
 
-Selecting the clocking section will display an empty table, click the "Add" button above the table to fill out clock information.
+Selecting the clocking section will display an empty table at the botton of the screen, click the "+Add" button above the table to fill out clock information.
 
 .. image:: figures/FPGA-figures-clocking-input_clock_info.JPG
 
-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.
+1. Select the clock source using the source dropdown menu
+2. Provide a description *(optional)* 
+3. Enter the Port/Signal name of the clock, *Note: Clock info will be required by all RPE sections, naming should be done clearly to be able to select the correct clocks.*
+4. Enter the clock frequency 
+    #. For **Boot Clock** & **RC Oscillator** sources refer to your device's datasheet and enter frequencies accordingly.
+5. Select the Clock State - default is **active**
+    #. Active for regular clock signals
+    #. Gated for unused not actively toggling or gated off signals
 
-FLE - Functional Logic Element 
+Repeat the steps above for each clock used in the RTL design.
+
+FLE - Fabric Logic Element 
 ###############################
 
 The FLE section is located on the top right of the FPGA input section.
 
 .. image:: figures/FPGA-figures-FLE-FLE_selected.JPG
 
-Selecting the FLE section displays an empty table, click the "Add" button above the table to fill out the FLE info.
+Selecting the FLE section displays an empty table at the botton of the screen, click the "+Add" button above the table to fill out the FLE info.
 
 .. image:: figures/FPGA-figures-FLE-input_FLE_info.JPG
 
-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. 
+1. Enter the name of your RTL module from your project's hierarchial view. *Note: You can leave this blank if you are providing FLE info for the entire design at once.* 
+2. Enter the no. of LUTs 
+3. Enter the no. of flip-flops
+4. Click on the clock dropdown, select the main clock responsible for running the design. 
+5. Enter toggle rate - Industry standard default is **12.5%** 
+6. Select glitch factor - default is **typical**
+    #. Typical - Default option, for standard designs.
+    #. High - For designs with high switching activity or complex logic.
+    #. Very High - For high performance designs with high-frequency logic or heavy use of pipelining.
+7. Enter clock enable rate - Inudustry standard default is **50.0%**
 
 BRAM - Block Randon Access Memory 
 ##################################
@@ -46,9 +65,15 @@ Selecting the BRAM section displays an empty table, click the "Add" button above
 
 .. image:: figures/FPGA-figures-BRAM-input_BRAM_ports_info.JPG
 
-Select the type of BRAM used on the RTL design, then the no. of that type of BRAM used. 
-
-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.
+1. Provide a name to label the BRAM function within the hierarchy (optional)
+2. Select the type of BRAM used in the RTL design
+3. Enter the no. of this type of BRAM used in the design 
+4. Enter Port A-White & Port B-Read info based on the type of BRAM selected
+    #. Clock - Select the clock which will be used to drive the BRAM Port
+    #. width - Enter BRAM's channel width, default is **16**
+    #. Write enable - Select based on BRAM type, default is **50% for SDP port A**
+    #. Read enable - Select based on BRAM type, default is **50% for SDP port B**
+    #. Toggle Rate - Industry standard default is **12.5%**
 
 DSP - Digital Signal Processor
 ###############################
@@ -61,7 +86,15 @@ Selecting the DSP section displays an empty table, click the "Add" button above
 
 .. image:: figures/FPGA-figures-DSP-input_DSP_info.JPG
 
-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.
+1. Provide a name to label the DSP function within the hierarchy (optional)
+2. Enter the no. of DSP multipliers 
+3. Select the DSP's mode from the dropdown menu
+4. Enter channel width for DSP inputs, *Note: The DSP Block is 20x18*
+     #. Input-A width must be between **1 & 20**
+     #. Input-B width must be between **1 & 18**
+5. Select a clock to drive the DSP
+6. Select the pipeline type 
+7. Enter toggle rate - Industry standard default is **12.5%**
 
 IO - Input/Output
 ##################
@@ -76,5 +109,29 @@ Selecting the IO section displays an empty table, click the "Add" button above t
 
 .. image:: figures/FPGA-figures-IO-input_IO_info2.JPG
 
-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
+1. Provide an IO port name 
+2. Enter the IO's bus width
+3. Select main RTL clock to drive the IO
+4. Enter duty cycle - Inudustry standard default is **50.0%**
+5. Select IO direction 
+    #. Input 
+    #. Output
+    #. Open-Drain
+    #. Bi-Directional
+6. Select IO standard - **LVCMOS 1.8v (HR)** as default
+7. Select drive strength - current the output buffer can supply to drive a signal through the connected load
+8. Select slew rate - how quickly the output signal transitions between logic levels
+    #. Fast - for high-speed signals
+    #. Slow - for lower power designs
+9.  Turn differential termination on/off - **off** as default
+10. Select pullup/pulldown resistors - **None** as default
+11. Select data type - default is **SDR**
+     #. SDR (Single Data Rate)  
+     #. DDR (Double Data Rate)
+     #. Clock
+     #. Asynchronus 
+12. Enter input enable rate - default is **50%** for inputs
+13. Enter output enable rate - default is **50%** for outputs 
+14. select synchronization option - default is **none** for signals that are already clocked and don't cross domains
+15. Enter toggle rate - Industry standard default is **12.5%**
 

docs/source/user_guide/SoC_index.rst

@@ -105,4 +105,3 @@ Enable/disable each channel using the checkboxes under the Enable column, then c
 .. image:: figures/SoC-figures-DMA-put_DMA_info.JPG
 
 For each channel, select a source & destination, typically a peripheral will be connected to a memory or vice-versa. Then select the active state, read/write rate & toggle rate.
-